/**
* gdk_app_launch_context_set_icon:
* @context: a `GdkAppLaunchContext`
- * @icon: (nullable): a #GIcon, or %NULL
+ * @icon: (nullable): a #GIcon
*
* Sets the icon for applications that are launched with this
* context.
/**
* gdk_app_launch_context_set_icon_name:
* @context: a `GdkAppLaunchContext`
- * @icon_name: (nullable): an icon name, or %NULL
+ * @icon_name: (nullable): an icon name
*
* Sets the icon for applications that are launched with this context.
*
* gdk_clipboard_store_finish:
* @clipboard: a `GdkClipboard`
* @result: a `GAsyncResult`
- * @error: a `GError` location to store the error occurring, or %NULL to ignore.
+ * @error: a `GError` location to store the error occurring
*
* Finishes an asynchronous clipboard store.
*
*
* See [method@Gdk.Clipboard.read_async].
*
- * Returns: (transfer full) (nullable): a `GInputStream` or %NULL on error
+ * Returns: (transfer full) (nullable): a `GInputStream`
*/
GInputStream *
gdk_clipboard_read_finish (GdkClipboard *clipboard,
* gdk_clipboard_read_value_finish:
* @clipboard: a `GdkClipboard`
* @result: a `GAsyncResult`
- * @error: a GError` location to store the error occurring, or %NULL to ignore
+ * @error: a GError` location to store the error occurring
*
* Finishes an asynchronous clipboard read.
*
* gdk_clipboard_read_texture_finish:
* @clipboard: a `GdkClipboard`
* @result: a `GAsyncResult`
- * @error: a `GError` location to store the error occurring, or %NULL to ignore
+ * @error: a `GError` location to store the error occurring
*
* Finishes an asynchronous clipboard read.
*
* See [method@Gdk.Clipboard.read_texture_async].
*
- * Returns: (transfer full) (nullable): a new `GdkTexture` or %NULL on error
+ * Returns: (transfer full) (nullable): a new `GdkTexture`
*/
GdkTexture *
gdk_clipboard_read_texture_finish (GdkClipboard *clipboard,
* gdk_clipboard_read_text_finish:
* @clipboard: a `GdkClipboard`
* @result: a `GAsyncResult`
- * @error: a `GError` location to store the error occurring, or %NULL to ignore
+ * @error: a `GError` location to store the error occurring
*
* Finishes an asynchronous clipboard read.
*
* See [method@Gdk.Clipboard.read_text_async].
*
- * Returns: (transfer full) (nullable): a new string or %NULL on error
+ * Returns: (transfer full) (nullable): a new string
*/
char *
gdk_clipboard_read_text_finish (GdkClipboard *clipboard,
*
* If no matching mime type is found, %NULL is returned.
*
- * Returns: (nullable): The first common mime type or %NULL if none.
+ * Returns: (nullable): The first common mime type or %NULL if none
*/
const char *
gdk_content_formats_match_mime_type (const GdkContentFormats *first,
* gdk_content_provider_write_mime_type_finish:
* @provider: a `GdkContentProvider`
* @result: a `GAsyncResult`
- * @error: a `GError` location to store the error occurring, or %NULL to ignore
+ * @error: a `GError` location to store the error occurring
*
* Finishes an asynchronous write operation.
*
* gdk_content_provider_get_value:
* @provider: a `GdkContentProvider`
* @value: the `GValue` to fill
- * @error: a `GError` location to store the error occurring, or %NULL to ignore
+ * @error: a `GError` location to store the error occurring
*
* Gets the contents of @provider stored in @value.
*
* it is used on does not support textured cursors.
*
* Returns: (transfer none) (nullable): the fallback of the cursor or %NULL
- * to use the default cursor as fallback.
+ * to use the default cursor as fallback
*/
GdkCursor *
gdk_cursor_get_fallback (GdkCursor *cursor)
* }
* ```
*
- * Returns: (nullable): the vendor ID, or %NULL
+ * Returns: (nullable): the vendor ID
*/
const char *
gdk_device_get_vendor_id (GdkDevice *device)
* This ID is retrieved from the device, and does not change.
* See [method@Gdk.Device.get_vendor_id] for more information.
*
- * Returns: (nullable): the product ID, or %NULL
+ * Returns: (nullable): the product ID
*/
const char *
gdk_device_get_product_id (GdkDevice *device)
*
* Retrieves the current tool for @device.
*
- * Returns: (transfer none): the `GdkDeviceTool`, or %NULL
+ * Returns: (transfer none): the `GdkDeviceTool`
*/
GdkDeviceTool *
gdk_device_get_device_tool (GdkDevice *device)
* drag operation. The surface is owned by @drag and will be destroyed
* when the drag operation is over.
*
- * Returns: (nullable) (transfer none): the drag surface, or %NULL
+ * Returns: (nullable) (transfer none): the drag surface
*/
GdkSurface *
gdk_drag_get_drag_surface (GdkDrag *drag)
*
* Retrieves the `GdkDisplay` the @context is created for
*
- * Returns: (nullable) (transfer none): a `GdkDisplay` or %NULL
+ * Returns: (nullable) (transfer none): the `GdkDisplay`
*/
GdkDisplay *
gdk_draw_context_get_display (GdkDrawContext *context)
*
* Retrieves the surface that @context is bound to.
*
- * Returns: (nullable) (transfer none): a #GdkSurface or %NULL
+ * Returns: (nullable) (transfer none): the #GdkSurface
*/
GdkSurface *
gdk_draw_context_get_surface (GdkDrawContext *context)
* @self: a `GdkDrop`
* @result: a `GAsyncResult`
* @out_mime_type: (out) (type utf8): return location for the used mime type
- * @error: (nullable): location to store error information on failure, or %NULL
+ * @error: (nullable): location to store error information on failure
*
* Finishes an async drop read operation.
*
*
* See [method@Gdk.Drop.read_async].
*
- * Returns: (nullable) (transfer full): the `GInputStream`, or %NULL
+ * Returns: (nullable) (transfer full): the `GInputStream`
*/
GInputStream *
gdk_drop_read_finish (GdkDrop *self,
* gdk_drop_read_value_finish:
* @self: a `GdkDrop`
* @result: a `GAsyncResult`
- * @error: a `GError` location to store the error occurring, or %NULL to ignore
+ * @error: a `GError` location to store the error occurring
*
* Finishes an async drop read.
*
* Removes and returns the first event from the event
* queue that is not still being filled in.
*
- * Returns: (nullable): the event, or %NULL. Ownership is transferred
- * to the caller.
- **/
+ * Returns: (nullable) (transfer full): the event
+ */
GdkEvent*
_gdk_event_unqueue (GdkDisplay *display)
{
* the application lifetime, if settings must be stored
* persistently across runs, see [method@Gdk.DeviceTool.get_serial].
*
- * Returns: (transfer none) (nullable): The current device tool, or %NULL
- **/
+ * Returns: (transfer none) (nullable): The current device tool
+ */
GdkDeviceTool *
gdk_event_get_device_tool (GdkEvent *event)
{
*
* Retrieves the display the @context is created for
*
- * Returns: (nullable) (transfer none): a `GdkDisplay` or %NULL
+ * Returns: (nullable) (transfer none): a `GdkDisplay`
*/
GdkDisplay *
gdk_gl_context_get_display (GdkGLContext *context)
*
* Retrieves the surface used by the @context.
*
- * Returns: (nullable) (transfer none): a `GdkSurface` or %NULL
+ * Returns: (nullable) (transfer none): a `GdkSurface`
*/
GdkSurface *
gdk_gl_context_get_surface (GdkGLContext *context)
*
* Retrieves the `GdkGLContext` that this @context share data with.
*
- * Returns: (nullable) (transfer none): a `GdkGLContext` or %NULL
+ * Returns: (nullable) (transfer none): a `GdkGLContext`
*/
GdkGLContext *
gdk_gl_context_get_shared_context (GdkGLContext *context)
*
* Retrieves the current `GdkGLContext`.
*
- * Returns: (nullable) (transfer none): the current `GdkGLContext`, or %NULL
+ * Returns: (nullable) (transfer none): the current `GdkGLContext`
*/
GdkGLContext *
gdk_gl_context_get_current (void)
* The PNP ID registry is located at
* [https://uefi.org/pnp_id_list](https://uefi.org/pnp_id_list).
*
- * Returns: (transfer none) (nullable): the name of the manufacturer,
- * or %NULL
+ * Returns: (transfer none) (nullable): the name of the manufacturer
*/
const char *
gdk_monitor_get_manufacturer (GdkMonitor *monitor)
*
* Gets the string identifying the monitor model, if available.
*
- * Returns: (transfer none) (nullable): the monitor model, or %NULL
+ * Returns: (transfer none) (nullable): the monitor model
*/
const char *
gdk_monitor_get_model (GdkMonitor *monitor)
* stages will almost certainly convert the pixbuf back into a texture
* to draw it on screen.
*
- * Returns: (transfer full) (nullable): a new #GdkPixbuf or %NULL
- * in case of an error
+ * Returns: (transfer full) (nullable): a new #GdkPixbuf
*/
GdkPixbuf *
gdk_pixbuf_get_from_texture (GdkTexture *texture)
* @src1: a `GdkRectangle`
* @src2: a `GdkRectangle`
* @dest: (out caller-allocates) (optional): return location for the
- * intersection of @src1 and @src2, or %NULL
+ * intersection of @src1 and @src2
*
* Calculates the intersection of two rectangles.
*
* Before using the returned `GdkGLContext`, you will need to
* call [method@Gdk.GLContext.make_current] or [method@Gdk.GLContext.realize].
*
- * Returns: (transfer full): the newly created `GdkGLContext`,
- * or %NULL on error
+ * Returns: (transfer full) (nullable): the newly created `GdkGLContext`
*/
GdkGLContext *
gdk_surface_create_gl_context (GdkSurface *surface,
* gdk_surface_get_device_position:
* @surface: a `GdkSurface`
* @device: pointer `GdkDevice` to query to
- * @x: (out) (optional): return locatio for the X coordinate of @device, or %NULL
- * @y: (out) (optional): return location for the Y coordinate of @device, or %NULL
- * @mask: (out) (optional): return location for the modifier mask, or %NULL
+ * @x: (out) (optional): return locatio for the X coordinate of @device
+ * @y: (out) (optional): return location for the Y coordinate of @device
+ * @mask: (out) (optional): return location for the modifier mask
*
* Obtains the current device position and modifier state.
*
* If the return value is %NULL then there is no custom cursor set on
* the surface, and it is using the cursor for its parent surface.
*
- * Returns: (nullable) (transfer none): a `GdkCursor`, or %NULL. The
- * returned object is owned by the `GdkSurface` and should not be
- * unreferenced directly. Use [method@Gdk.Surface.set_cursor] to
- * unset the cursor of the surface
+ * Use [method@Gdk.Surface.set_cursor] to unset the cursor of the surface.
+ *
+ * Returns: (nullable) (transfer none): a `GdkCursor`
*/
GdkCursor *
gdk_surface_get_cursor (GdkSurface *surface)
* If the return value is %NULL then there is no custom cursor set on the
* specified surface, and it is using the cursor for its parent surface.
*
- * Returns: (nullable) (transfer none): a `GdkCursor`, or %NULL. The
- * returned object is owned by the `GdkSurface` and should not be
- * unreferenced directly. Use [method@Gdk.Surface.set_cursor] to unset
- * the cursor of the surface
+ * Use [method@Gdk.Surface.set_cursor] to unset the cursor of the surface.
+ *
+ * Returns: (nullable) (transfer none): a `GdkCursor`
*/
GdkCursor *
gdk_surface_get_device_cursor (GdkSurface *surface,
* the source if [method@Gdk.Drag.get_selected_action] returns
* %GDK_ACTION_MOVE.
*
- * Returns: (transfer full) (nullable): a newly created [class@Gdk.Drag]
- * or %NULL on error
+ * Returns: (transfer full) (nullable): a newly created `GdkDrag`
*/
GdkDrag *
gdk_drag_begin (GdkSurface *surface,
/**
* gdk_surface_set_opaque_region:
* @surface: a top-level `GdkSurface`
- * @region: (nullable): a region, or %NULL
+ * @region: (nullable): a region, or %NULL to make the entire
+ * surface opaque
*
* Marks a region of the `GdkSurface` as opaque.
*
*
* If %NULL is returned, then @error will be set.
*
- * Return value: A newly-created `GdkTexture` or %NULL if an error occurred.
+ * Return value: A newly-created `GdkTexture`
*/
GdkTexture *
gdk_texture_new_from_file (GFile *file,
* Gets the startup notification ID for a Wayland display, or %NULL
* if no ID has been defined.
*
- * Returns: (nullable): the startup notification ID for @display, or %NULL
+ * Returns: (nullable): the startup notification ID for @display
*/
const char *
gdk_wayland_display_get_startup_notification_id (GdkDisplay *display)
* Given the root window ID of one of the screen’s of a #GdkDisplay,
* finds the screen.
*
- * Returns: (transfer none): the #GdkX11Screen corresponding to
- * @xrootwin, or %NULL.
- **/
+ * Returns: (transfer none) (nullable): the #GdkX11Screen
+ * corresponding to @xrootwin
+ */
GdkX11Screen *
_gdk_x11_display_screen_for_xrootwin (GdkDisplay *display,
Window xrootwin)
*
* Looks up the #GdkVisual for a particular screen and X Visual ID.
*
- * Returns: (transfer none) (type GdkX11Visual): the #GdkVisual (owned by the screen
- * object), or %NULL if the visual ID wasn’t found.
+ * Returns: (transfer none) (nullable) (type GdkX11Visual): the #GdkVisual
*/
GdkX11Visual *
gdk_x11_screen_lookup_visual (GdkX11Screen *x11_screen,
* Gets the resource path for the GLSL sourcecode being used
* to render this shader.
*
- * Returns: (transfer none): The resource path for the shader,
- * or %NULL if none.
+ * Returns: (transfer none) (nullable): The resource path for the shader
*/
const char *
gsk_gl_shader_get_resource (GskGLShader *shader)
/**
* gsk_render_node_deserialize:
* @bytes: the bytes containing the data
- * @error_func: (nullable) (scope call): Callback on parsing errors or %NULL
+ * @error_func: (nullable) (scope call): Callback on parsing errors
* @user_data: (closure error_func): user_data for @error_func
*
* Loads data previously created via gsk_render_node_serialize().
* @transform_class: class structure for this self
* @category: The category of this transform. Will be used to initialize
* the result's category together with &next's category
- * @next: (transfer full): Next transform to multiply with or %NULL if none
+ * @next: (transfer full) (nullable): Next transform to multiply with
*
* Returns: (transfer full): the newly created #GskTransform
*/
/*<private>
* gsk_transform_is_identity:
- * @transform: (nullable): A transform or %NULL
+ * @transform: (nullable): A transform
*
* Checks if the transform is a representation of the identity
* transform.
* gsk_ngl_driver_lookup_shader:
* @self: a #GskNglDriver
* @shader: the shader to lookup or load
- * @error: a location for a #GError, or %NULL
+ * @error: a location for a #GError
*
* Attepts to load @shader from the shader cache.
*
* If it has not been loaded, then it will compile the shader on demand.
*
- * Returns: (transfer none): a #GskGLShader if successful; otherwise
- * %NULL and @error is set.
+ * Returns: (nullable) (transfer none): a #GskGLShader
*/
GskNglProgram *
gsk_ngl_driver_lookup_shader (GskNglDriver *self,
* @url: the URL to parse
* @out_mimetype: (out nullable optional): Return location to set the contained
* mime type to. If no mime type was specified, this value is set to %NULL.
- * @error: error location or %NULL for none
+ * @error: error location
*
* Decodes a data URL according to RFC2397 and returns the decoded data.
*
- * Returns: a new #GBytes with the decoded data or %NULL on error
+ * Returns: a new #GBytes with the decoded data
**/
GBytes *
gtk_css_data_url_parse (const char *url,
* for example when raw data is parsed - %NULL is returned.
*
* Returns: (nullable) (transfer none): The file being parsed
- * or %NULL.
- **/
+ */
GFile *
gtk_css_parser_get_file (GtkCssParser *self)
{
* consumes it, resolves the URL and returns the resulting #GFile.
* On failure, an error is emitted and %NULL is returned.
*
- * Returns: (nullable) (transfer full): the resulting URL or %NULL on error
+ * Returns: (nullable) (transfer full): the resulting URL
**/
char *
gtk_css_parser_consume_url (GtkCssParser *self)
/**
* gtk_app_chooser_dialog_new:
- * @parent: (nullable): a `GtkWindow`, or %NULL
+ * @parent: (nullable): a `GtkWindow`
* @flags: flags for this dialog
* @file: a `GFile`
*
/**
* gtk_app_chooser_dialog_new_for_content_type:
- * @parent: (nullable): a `GtkWindow`, or %NULL
+ * @parent: (nullable): a `GtkWindow`
* @flags: flags for this dialog
* @content_type: a content type string
*
* See [method@Gtk.ApplicationWindow.set_help_overlay].
*
* Returns: (transfer none) (nullable): the help overlay associated
- * with @window, or %NULL
+ * with @window
*/
GtkShortcutsWindow *
gtk_application_window_get_help_overlay (GtkApplicationWindow *window)
/**
* gtk_assistant_set_forward_page_func:
* @assistant: a `GtkAssistant`
- * @page_func: (nullable): the `GtkAssistant`PageFunc, or %NULL
+ * @page_func: (nullable): the `GtkAssistantPageFunc`, or %NULL
* to use the default one
* @data: user data for @page_func
* @destroy: destroy notifier for @data
* gtk_box_reorder_child_after:
* @box: a `GtkBox`
* @child: the `GtkWidget` to move, must be a child of @box
- * @sibling: (nullable): the sibling to move @child after, or %NULL
+ * @sibling: (nullable): the sibling to move @child after
*
* Moves @child to the position after @sibling in the list
* of @box children.
* @buildable: a `GtkBuildable`
* @builder: a `GtkBuilder`
* @child: child to add
- * @type: (nullable): kind of child or %NULL
+ * @type: (nullable): kind of child
*
* Adds a child to @buildable. @type is an optional string
* describing how the child should be added.
* gtk_builder_add_from_file:
* @builder: a `GtkBuilder`
* @filename: the name of the file to parse
- * @error: (nullable): return location for an error, or %NULL
+ * @error: (nullable): return location for an error
*
* Parses a file containing a UI definition and merges it with
* the current contents of @builder.
* @builder: a `GtkBuilder`
* @filename: the name of the file to parse
* @object_ids: (array zero-terminated=1) (element-type utf8): nul-terminated array of objects to build
- * @error: (nullable): return location for an error, or %NULL
+ * @error: (nullable): return location for an error
*
* Parses a file containing a UI definition building only the
* requested objects and merges them with the current contents
* @template_type: the type that the template is for
* @buffer: the string to parse
* @length: the length of @buffer (may be -1 if @buffer is nul-terminated)
- * @error: (nullable): return location for an error, or %NULL
+ * @error: (nullable): return location for an error
*
* Main private entry point for building composite components
* from template XML.
* gtk_builder_add_from_resource:
* @builder: a `GtkBuilder`
* @resource_path: the path of the resource file to parse
- * @error: (nullable): return location for an error, or %NULL
+ * @error: (nullable): return location for an erro
*
* Parses a resource file containing a UI definition
* and merges it with the current contents of @builder.
* @builder: a `GtkBuilder`
* @resource_path: the path of the resource file to parse
* @object_ids: (array zero-terminated=1) (element-type utf8): nul-terminated array of objects to build
- * @error: (nullable): return location for an error, or %NULL
+ * @error: (nullable): return location for an error
*
* Parses a resource file containing a UI definition, building
* only the requested objects and merges them with the current
* @builder: a `GtkBuilder`
* @buffer: the string to parse
* @length: the length of @buffer (may be -1 if @buffer is nul-terminated)
- * @error: (nullable): return location for an error, or %NULL
+ * @error: (nullable): return location for an error
*
* Parses a string containing a UI definition and merges it
* with the current contents of @builder.
* @buffer: the string to parse
* @length: the length of @buffer (may be -1 if @buffer is nul-terminated)
* @object_ids: (array zero-terminated=1) (element-type utf8): nul-terminated array of objects to build
- * @error: (nullable): return location for an error, or %NULL
+ * @error: (nullable): return location for an error
*
* Parses a string containing a UI definition, building only the
* requested objects and merges them with the current contents of
* of the returned object.
*
* Returns: (nullable) (transfer none): the object named @name
- * or %NULL if it could not be found in the object tree.
*/
GObject *
gtk_builder_get_object (GtkBuilder *builder,
/**
* gtk_builder_set_translation_domain: (attributes org.gtk.Method.set_property=translation-domain)
* @builder: a `GtkBuilder`
- * @domain: (nullable): the translation domain or %NULL
+ * @domain: (nullable): the translation domain
*
* Sets the translation domain of @builder.
*/
* Gets the translation domain of @builder.
*
* Returns: (transfer none) (nullable): the translation domain
- * or %NULL. This string is owned by the builder object and
- * must not be modified or freed.
*/
const char *
gtk_builder_get_translation_domain (GtkBuilder *builder)
* @pspec: the `GParamSpec` for the property
* @string: the string representation of the value
* @value: (out): the `GValue` to store the result in
- * @error: (nullable): return location for an error, or %NULL
+ * @error: (nullable): return location for an error
*
* Demarshals a value from a string.
*
* @type: the `GType` of the value
* @string: the string representation of the value
* @value: (out): the #GValue to store the result in
- * @error: (nullable): return location for an error, or %NULL
+ * @error: (nullable): return location for an error
*
* Demarshals a value from a string.
*
* @function_name: name of the function to look up
* @flags: closure creation flags
* @object: (nullable): Object to create the closure with
- * @error: (nullable): return location for an error, or %NULL
+ * @error: (nullable): return location for an error
*
* Creates a closure to invoke the function called @function_name.
*
* give the element_name as passed to those functions. For the parent
* elements, see gtk_buildable_parse_context_get_element_stack().
*
- * Returns: (nullable): the name of the currently open element, or %NULL
+ * Returns: (nullable): the name of the currently open element
*/
const char *
gtk_buildable_parse_context_get_element (GtkBuildableParseContext *context)
/**
* gtk_buildable_parse_context_get_position:
* @context: a #GtkBuildableParseContext
- * @line_number: (out) (optional): return location for a line number, or %NULL
- * @char_number: (out) (optional): return location for a char-on-line number, or %NULL
+ * @line_number: (out) (optional): return location for a line number
+ * @char_number: (out) (optional): return location for a char-on-line number
*
* Retrieves the current line number and the number of the character on
* that line. Intended for use in error messages; there are no strict
* gtk_builder_cscope_add_callback_symbol().
*
* Returns: (nullable) (transfer none): The callback symbol
- * in @builder for @callback_name, or %NULL
+ * in @builder for @callback_name
*/
GCallback
gtk_builder_cscope_lookup_callback_symbol (GtkBuilderCScope *self,
/**
* gtk_button_new_from_icon_name:
- * @icon_name: (nullable): an icon name or %NULL
+ * @icon_name: (nullable): an icon name
*
* Creates a new button containing an icon from the current icon theme.
*
* @context: the #GtkCellAreaContext used to hold sizes for @area.
* @widget: the #GtkWidget that @area is rendering on
* @cell_area: the whole allocated area for @area in @widget
- * for this row
+ * for this row
* @x: the x position
* @y: the y position
* @alloc_area: (out) (optional): where to store the inner allocated area of the
- * returned cell renderer, or %NULL.
+ * returned cell renderer
*
* Gets the #GtkCellRenderer at @x and @y coordinates inside @area and optionally
* returns the full cell allocation for it inside @cell_area.
* @area: a #GtkCellArea
* @context: the #GtkCellAreaContext to perform this request with
* @widget: the #GtkWidget where @area will be rendering
- * @minimum_width: (out) (optional): location to store the minimum width, or %NULL
- * @natural_width: (out) (optional): location to store the natural width, or %NULL
+ * @minimum_width: (out) (optional): location to store the minimum width
+ * @natural_width: (out) (optional): location to store the natural width
*
* Retrieves a cell area’s initial minimum and natural width.
*
* @context: the #GtkCellAreaContext which has already been requested for widths.
* @widget: the #GtkWidget where @area will be rendering
* @width: the width for which to check the height of this area
- * @minimum_height: (out) (optional): location to store the minimum height, or %NULL
- * @natural_height: (out) (optional): location to store the natural height, or %NULL
+ * @minimum_height: (out) (optional): location to store the minimum height
+ * @natural_height: (out) (optional): location to store the natural height
*
* Retrieves a cell area’s minimum and natural height if it would be given
* the specified @width.
* @area: a #GtkCellArea
* @context: the #GtkCellAreaContext to perform this request with
* @widget: the #GtkWidget where @area will be rendering
- * @minimum_height: (out) (optional): location to store the minimum height, or %NULL
- * @natural_height: (out) (optional): location to store the natural height, or %NULL
+ * @minimum_height: (out) (optional): location to store the minimum height
+ * @natural_height: (out) (optional): location to store the natural height
*
* Retrieves a cell area’s initial minimum and natural height.
*
* @context: the #GtkCellAreaContext which has already been requested for widths.
* @widget: the #GtkWidget where @area will be rendering
* @height: the height for which to check the width of this area
- * @minimum_width: (out) (optional): location to store the minimum width, or %NULL
- * @natural_width: (out) (optional): location to store the natural width, or %NULL
+ * @minimum_width: (out) (optional): location to store the minimum width
+ * @natural_width: (out) (optional): location to store the natural width
*
* Retrieves a cell area’s minimum and natural width if it would be given
* the specified @height.
*
* Finds a cell property of a cell area class by name.
*
- * Returns: (transfer none): the #GParamSpec of the child property
- * or %NULL if @aclass has no child property with that name.
+ * Returns: (nullable) (transfer none): the #GParamSpec of the child property
*/
GParamSpec*
gtk_cell_area_class_find_cell_property (GtkCellAreaClass *aclass,
* cell may have been a sibling.
*
* Returns: (nullable) (transfer none): the #GtkCellRenderer for which @renderer
- * is a sibling, or %NULL.
+ * is a sibling
*/
GtkCellRenderer *
gtk_cell_area_get_focus_from_sibling (GtkCellArea *area,
* @widget: the #GtkWidget that @area is rendering onto
* @for_size: the allocation contextual size to request for, or -1 if
* the base request for the orientation is to be returned.
- * @minimum_size: (out) (optional): location to store the minimum size, or %NULL
- * @natural_size: (out) (optional): location to store the natural size, or %NULL
+ * @minimum_size: (out) (optional): location to store the minimum size
+ * @natural_size: (out) (optional): location to store the natural size
*
* This is a convenience function for #GtkCellArea implementations
* to request size for cell renderers. It’s important to use this
/**
* gtk_cell_area_context_get_allocation:
* @context: a #GtkCellAreaContext
- * @width: (out) (optional): location to store the allocated width, or %NULL
- * @height: (out) (optional): location to store the allocated height, or %NULL
+ * @width: (out) (optional): location to store the allocated width
+ * @height: (out) (optional): location to store the allocated height
*
* Fetches the current allocation size for @context.
*
* gtk_cell_layout_set_cell_data_func:
* @cell_layout: a #GtkCellLayout
* @cell: a #GtkCellRenderer
- * @func: (nullable): the #GtkCellLayoutDataFunc to use, or %NULL
+ * @func: (nullable): the #GtkCellLayoutDataFunc to use
* @func_data: (closure): user data for @func
* @destroy: destroy notify for @func_data
*
* if called on a #GtkCellArea or might be %NULL if no #GtkCellArea
* is used by @cell_layout.
*
- * Returns: (transfer none) (nullable): the cell area used by @cell_layout,
- * or %NULL in case no cell area is used.
+ * Returns: (transfer none) (nullable): the cell area used by @cell_layout
*/
GtkCellArea *
gtk_cell_layout_get_area (GtkCellLayout *cell_layout)
/**
* gtk_cell_renderer_get_fixed_size:
* @cell: A #GtkCellRenderer
- * @width: (out) (optional): location to fill in with the fixed width of the cell, or %NULL
- * @height: (out) (optional): location to fill in with the fixed height of the cell, or %NULL
+ * @width: (out) (optional): location to fill in with the fixed width of the cell
+ * @height: (out) (optional): location to fill in with the fixed height of the cell
*
* Fills in @width and @height with the appropriate size of @cell.
**/
/**
* gtk_cell_renderer_get_alignment:
* @cell: A #GtkCellRenderer
- * @xalign: (out) (optional): location to fill in with the x alignment of the cell, or %NULL
- * @yalign: (out) (optional): location to fill in with the y alignment of the cell, or %NULL
+ * @xalign: (out) (optional): location to fill in with the x alignment of the cell
+ * @yalign: (out) (optional): location to fill in with the y alignment of the cell
*
* Fills in @xalign and @yalign with the appropriate values of @cell.
**/
/**
* gtk_cell_renderer_get_padding:
* @cell: A #GtkCellRenderer
- * @xpad: (out) (optional): location to fill in with the x padding of the cell, or %NULL
- * @ypad: (out) (optional): location to fill in with the y padding of the cell, or %NULL
+ * @xpad: (out) (optional): location to fill in with the x padding of the cell
+ * @ypad: (out) (optional): location to fill in with the y padding of the cell
*
* Fills in @xpad and @ypad with the appropriate values of @cell.
**/
* gtk_cell_renderer_get_preferred_width:
* @cell: a #GtkCellRenderer instance
* @widget: the #GtkWidget this cell will be rendering to
- * @minimum_size: (out) (optional): location to store the minimum size, or %NULL
- * @natural_size: (out) (optional): location to store the natural size, or %NULL
+ * @minimum_size: (out) (optional): location to store the minimum size
+ * @natural_size: (out) (optional): location to store the natural size
*
* Retrieves a renderer’s natural size when rendered to @widget.
*/
* gtk_cell_renderer_get_preferred_height:
* @cell: a #GtkCellRenderer instance
* @widget: the #GtkWidget this cell will be rendering to
- * @minimum_size: (out) (optional): location to store the minimum size, or %NULL
- * @natural_size: (out) (optional): location to store the natural size, or %NULL
+ * @minimum_size: (out) (optional): location to store the minimum size
+ * @natural_size: (out) (optional): location to store the natural size
*
* Retrieves a renderer’s natural size when rendered to @widget.
*/
* @cell: a #GtkCellRenderer instance
* @widget: the #GtkWidget this cell will be rendering to
* @height: the size which is available for allocation
- * @minimum_width: (out) (optional): location for storing the minimum size, or %NULL
- * @natural_width: (out) (optional): location for storing the preferred size, or %NULL
+ * @minimum_width: (out) (optional): location for storing the minimum size
+ * @natural_width: (out) (optional): location for storing the preferred size
*
* Retrieves a cell renderers’s minimum and natural width if it were rendered to
* @widget with the specified @height.
* @cell: a #GtkCellRenderer instance
* @widget: the #GtkWidget this cell will be rendering to
* @width: the size which is available for allocation
- * @minimum_height: (out) (optional): location for storing the minimum size, or %NULL
- * @natural_height: (out) (optional): location for storing the preferred size, or %NULL
+ * @minimum_height: (out) (optional): location for storing the minimum size
+ * @natural_height: (out) (optional): location for storing the preferred size
*
* Retrieves a cell renderers’s minimum and natural height if it were rendered to
* @widget with the specified @width.
* gtk_cell_renderer_get_preferred_size:
* @cell: a #GtkCellRenderer instance
* @widget: the #GtkWidget this cell will be rendering to
- * @minimum_size: (out) (optional): location for storing the minimum size, or %NULL
- * @natural_size: (out) (optional): location for storing the natural size, or %NULL
+ * @minimum_size: (out) (optional): location for storing the minimum size
+ * @natural_size: (out) (optional): location for storing the natural size
*
* Retrieves the minimum and natural size of a cell taking
* into account the widget’s preference for height-for-width management.
/**
* gtk_cell_renderer_get_state:
- * @cell: (nullable): a #GtkCellRenderer, or %NULL
- * @widget: (nullable): a #GtkWidget, or %NULL
+ * @cell: (nullable): a #GtkCellRenderer
+ * @widget: (nullable): a #GtkWidget
* @cell_state: cell renderer state
*
* Translates the cell renderer state to #GtkStateFlags,
* Returns the model for @cell_view. If no model is used %NULL is
* returned.
*
- * Returns: (nullable) (transfer none): a #GtkTreeModel used or %NULL
- **/
+ * Returns: (nullable) (transfer none): a #GtkTreeModel used
+ */
GtkTreeModel *
gtk_cell_view_get_model (GtkCellView *cell_view)
{
* displayed row. If no row is currently displayed,
* %NULL is returned.
*
- * Returns: (nullable) (transfer full): the currently displayed row or %NULL
+ * Returns: (nullable) (transfer full): the currently displayed row
*/
GtkTreePath *
gtk_cell_view_get_displayed_row (GtkCellView *cell_view)
/**
* gtk_center_box_set_start_widget:
* @self: a `GtkCenterBox`
- * @child: (nullable): the new start widget, or %NULL
+ * @child: (nullable): the new start widget
*
* Sets the start widget.
*
/**
* gtk_center_box_set_center_widget:
* @self: a `GtkCenterBox`
- * @child: (nullable): the new center widget, or %NULL
+ * @child: (nullable): the new center widget
*
* Sets the center widget.
*
/**
* gtk_center_box_set_end_widget:
* @self: a `GtkCenterBox`
- * @child: (nullable): the new end widget, or %NULL
+ * @child: (nullable): the new end widget
*
* Sets the end widget.
*
* be displayed in rows, %GTK_ORIENTATION_VERTICAL for columns
* @colors_per_line: the number of colors to show in each row/column
* @n_colors: the total number of elements in @colors
- * @colors: (nullable) (array length=n_colors): the colors of the palette, or %NULL
+ * @colors: (nullable) (array length=n_colors): the colors of the palette
*
* Adds a palette to the color chooser.
*
/**
* gtk_color_chooser_dialog_new:
- * @title: (nullable): Title of the dialog, or %NULL
- * @parent: (nullable): Transient parent of the dialog, or %NULL
+ * @title: (nullable): Title of the dialog
+ * @parent: (nullable): Transient parent of the dialog
*
* Creates a new `GtkColorChooserDialog`.
*
/**
* gtk_column_view_new:
- * @model: (nullable) (transfer full): the list model to use, or %NULL
+ * @model: (nullable) (transfer full): the list model to use
*
* Creates a new `GtkColumnView`.
*
/**
* gtk_column_view_set_model: (attributes org.gtk.Method.set_property=model)
* @self: a #GtkColumnView
- * @model: (nullable) (transfer none): the model to use or %NULL for none
+ * @model: (nullable) (transfer none): the model to use
*
* Sets the model to use.
*
/**
* gtk_column_view_sort_by_column:
* @self: a `GtkColumnView`
- * @column: (nullable): the `GtkColumnViewColumn` to sort by, or %NULL
+ * @column: (nullable): the `GtkColumnViewColumn` to sort by
* @direction: the direction to sort in
*
* Sets the sorting of the view.
/**
* gtk_column_view_column_set_factory: (attributes org.gtk.Method.set_property=factory)
* @self: a `GtkColumnViewColumn`
- * @factory: (nullable) (transfer none): the factory to use or %NULL for none
+ * @factory: (nullable) (transfer none): the factory to use
*
* Sets the `GtkListItemFactory` to use for populating list items for this
* column.
/**
* gtk_column_view_column_set_header_menu: (attributes org.gtk.Method.set_property=header-menu)
* @self: a `GtkColumnViewColumn`
- * @menu: (nullable): a `GMenuModel`, or %NULL
+ * @menu: (nullable): a `GMenuModel`
*
* Sets the menu model that is used to create the context menu
* for the column header.
* Gets the menu model that is used to create the context menu
* for the column header.
*
- * Returns: (transfer none) (nullable): the #GMenuModel, or %NULL
+ * Returns: (transfer none) (nullable): the #GMenuModel
*/
GMenuModel *
gtk_column_view_column_get_header_menu (GtkColumnViewColumn *self)
/**
* gtk_combo_box_set_active_iter:
* @combo_box: A `GtkComboBox`
- * @iter: (nullable): The `GtkTreeIter`, or %NULL
+ * @iter: (nullable): The `GtkTreeIter`
*
* Sets the current active item to be the one referenced by @iter.
*
* gtk_combo_box_set_row_separator_func:
* @combo_box: a `GtkComboBox`
* @func: (nullable): a `GtkTreeViewRowSeparatorFunc`
- * @data: (nullable): user data to pass to @func, or %NULL
- * @destroy: (nullable): destroy notifier for @data, or %NULL
+ * @data: (nullable): user data to pass to @func
+ * @destroy: (nullable): destroy notifier for @data
*
* Sets the row separator function, which is used to determine
* whether a row should be drawn as a separator.
* not set, or if no row is active, or if the active row has a %NULL
* ID value, then %NULL is returned.
*
- * Returns: (nullable): the ID of the active row, or %NULL
+ * Returns: (nullable): the ID of the active row
*/
const char *
gtk_combo_box_get_active_id (GtkComboBox *combo_box)
/**
* gtk_combo_box_set_active_id: (attributes org.gtk.Method.set_property=active-id)
* @combo_box: a `GtkComboBox`
- * @active_id: (nullable): the ID of the row to select, or %NULL
+ * @active_id: (nullable): the ID of the row to select
*
* Changes the active row of @combo_box to the one that has an ID equal to
* @active_id.
/**
* gtk_combo_box_text_append:
* @combo_box: A `GtkComboBoxText`
- * @id: (nullable): a string ID for this value, or %NULL
+ * @id: (nullable): a string ID for this value
* @text: A string
*
* Appends @text to the list of strings stored in @combo_box.
/**
* gtk_combo_box_text_prepend:
* @combo_box: A `GtkComboBox`
- * @id: (nullable): a string ID for this value, or %NULL
+ * @id: (nullable): a string ID for this value
* @text: a string
*
* Prepends @text to the list of strings stored in @combo_box.
* gtk_combo_box_text_insert:
* @combo_box: A `GtkComboBoxText`
* @position: An index to insert @text
- * @id: (nullable): a string ID for this value, or %NULL
+ * @id: (nullable): a string ID for this value
* @text: A string to display
*
* Inserts @text at @position in the list of strings stored in @combo_box.
* _gtk_css_lookup_set:
* @lookup: the lookup
* @id: id of the property to set, see _gtk_style_property_get_id()
- * @section: (nullable): The @section the value was defined in or %NULL
+ * @section: (nullable): The @section the value was defined in
* @value: the “cascading value” to use
*
* Sets the @value for a given @id. No value may have been set for @id
/**
* gtk_custom_paper_unix_dialog_new:
- * @title: (nullable): the title of the dialog, or %NULL
- * @parent: (nullable): transient parent of the dialog, or %NULL
+ * @title: (nullable): the title of the dialog
+ * @parent: (nullable): transient parent of the dialog
*
* Creates a new custom paper dialog.
*
/**
* gtk_dialog_new_with_buttons:
- * @title: (nullable): Title of the dialog, or %NULL
- * @parent: (nullable): Transient parent of the dialog, or %NULL
+ * @title: (nullable): Title of the dialog
+ * @parent: (nullable): Transient parent of the dialog
* @flags: from `GtkDialogFlags`
- * @first_button_text: (nullable): text to go in first button, or %NULL
+ * @first_button_text: (nullable): text to go in first button
* @...: response ID for first button, then additional buttons, ending with %NULL
*
* Creates a new `GtkDialog` with the given title and transient parent.
/**
* gtk_drag_icon_set_child: (attributes org.gtk.Method.set_property=child)
* @self: a `GtkDragIcon`
- * @child: (nullable): a `GtkWidget` or %NULL
+ * @child: (nullable): a `GtkWidget`
*
* Sets the widget to display as the drag icon.
*/
*
* Gets the widget currently used as drag icon.
*
- * Returns: (nullable) (transfer none): The drag icon or %NULL if none.
+ * Returns: (nullable) (transfer none): The drag icon
**/
GtkWidget *
gtk_drag_icon_get_child (GtkDragIcon *self)
* the [property@Gtk.DragSource:content] property, so if you set up that
* property ahead of time, you don't need to connect to this signal.
*
- * Returns: (transfer full) (nullable): a `GdkContentProvider`, or %NULL
+ * Returns: (transfer full) (nullable): a `GdkContentProvider`
*/
signals[PREPARE] =
g_signal_new (I_("prepare"),
/**
* gtk_drag_source_set_content: (attributes org.gtk.Method.set_property=content)
* @source: a `GtkDragSource`
- * @content: (nullable): a `GdkContentProvider`, or %NULL
+ * @content: (nullable): a `GdkContentProvider`
*
* Sets a content provider on a `GtkDragSource`.
*
/**
* gtk_drag_source_set_icon:
* @source: a `GtkDragSource`
- * @paintable: (nullable): the #GdkPaintable to use as icon, or %NULL
+ * @paintable: (nullable): the #GdkPaintable to use as icon
* @hot_x: the hotspot X coordinate on the icon
* @hot_y: the hotspot Y coordinate on the icon
*
* Returns the underlying `GdkDrag` object for an ongoing drag.
*
* Returns: (nullable) (transfer none): the `GdkDrag` of the current
- * drag operation, or %NULL
+ * drag operation
*/
GdkDrag *
gtk_drag_source_get_drag (GtkDragSource *source)
* over the widget of @self.
*
* Returns: (transfer none) (nullable): The `GdkDrop` currently
- * happening within @self or %NULL if none
+ * happening within @self
*/
GdkDrop *
gtk_drop_controller_motion_get_drop (GtkDropControllerMotion *self)
/**
* gtk_drop_down_new:
- * @model: (transfer full) (nullable): the model to use or %NULL for none
- * @expression: (transfer full) (nullable): the expression to use or %NULL for none
+ * @model: (transfer full) (nullable): the model to use
+ * @expression: (transfer full) (nullable): the expression to use
*
* Creates a new `GtkDropDown`.
*
/**
* gtk_drop_down_set_model: (attributes org.gtk.Method.set_property=model)
* @self: a `GtkDropDown`
- * @model: (nullable) (transfer none): the model to use or %NULL for none
+ * @model: (nullable) (transfer none): the model to use
*
* Sets the `GListModel` to use.
*/
/**
* gtk_drop_down_set_factory: (attributes org.gtk.Method.set_property=factory)
* @self: a `GtkDropDown`
- * @factory: (nullable) (transfer none): the factory to use or %NULL for none
+ * @factory: (nullable) (transfer none): the factory to use
*
* Sets the `GtkListItemFactory` to use for populating list items.
**/
/**
* gtk_drop_down_set_list_factory: (attributes org.gtk.Method.set_property=list-factory)
* @self: a `GtkDropDown`
- * @factory: (nullable) (transfer none): the factory to use or %NULL for none
+ * @factory: (nullable) (transfer none): the factory to use
*
* Sets the `GtkListItemFactory` to use for populating list items in the popup.
*/
/**
* gtk_drop_down_set_expression: (attributes org.gtk.Method.set_property=expression)
* @self: a `GtkDropDown`
- * @expression: (nullable): a `GtkExpression`, or %NULL
+ * @expression: (nullable): a `GtkExpression`
*
* Sets the expression that gets evaluated to obtain strings from items.
*
*
* See [method@Gtk.DropDown.set_expression].
*
- * Returns: (nullable) (transfer none): a `GtkExpression` or %NULL
+ * Returns: (nullable) (transfer none): a `GtkExpression`
*/
GtkExpression *
gtk_drop_down_get_expression (GtkDropDown *self)
/**
* gtk_editable_get_selection_bounds:
* @editable: a `GtkEditable`
- * @start_pos: (out) (optional): location to store the starting position, or %NULL
- * @end_pos: (out) (optional): location to store the end position, or %NULL
+ * @start_pos: (out) (optional): location to store the starting position
+ * @end_pos: (out) (optional): location to store the end position
*
* Retrieves the selection bound of the editable.
*
* gtk_entry_set_icon_from_paintable:
* @entry: a `GtkEntry`
* @icon_pos: Icon position
- * @paintable: (nullable): A `GdkPaintable`, or %NULL
+ * @paintable: (nullable): A `GdkPaintable`
*
* Sets the icon shown in the specified position using a `GdkPaintable`.
*
* gtk_entry_set_icon_from_icon_name:
* @entry: A `GtkEntry`
* @icon_pos: The position at which to set the icon
- * @icon_name: (nullable): An icon name, or %NULL
+ * @icon_name: (nullable): An icon name
*
* Sets the icon shown in the entry at the specified position
* from the current icon theme.
* gtk_entry_set_icon_from_gicon:
* @entry: A `GtkEntry`
* @icon_pos: The position at which to set the icon
- * @icon: (nullable): The icon to set, or %NULL
+ * @icon: (nullable): The icon to set
*
* Sets the icon shown in the entry at the specified position
* from the current icon theme.
*
* If no `GdkPaintable` was used for the icon, %NULL is returned.
*
- * Returns: (transfer none) (nullable): A `GdkPaintable`, or %NULL
+ * Returns: (transfer none) (nullable): A `GdkPaintable`
* if no icon is set for this position or the icon set is not
* a `GdkPaintable`.
*/
* %NULL will be returned if there is no icon or if the icon was
* set by some other method (e.g., by `GdkPaintable` or icon name).
*
- * Returns: (transfer none) (nullable): A `GIcon`, or %NULL if no
- * icon is set or if the icon is not a `GIcon`
+ * Returns: (transfer none) (nullable): A `GIcon`
*/
GIcon *
gtk_entry_get_icon_gicon (GtkEntry *entry,
* %NULL is returned if there is no icon or if the icon was set
* by some other method (e.g., by `GdkPaintable` or gicon).
*
- * Returns: (nullable): An icon name, or %NULL if no icon is set
- * or if the icon wasn’t set from an icon name
+ * Returns: (nullable): An icon name
*/
const char *
gtk_entry_get_icon_name (GtkEntry *entry,
* Gets the contents of the tooltip on the icon at the specified
* position in @entry.
*
- * Returns: (nullable): the tooltip text, or %NULL. Free the returned
- * string with g_free() when done.
+ * Returns: (nullable) (transfer full): the tooltip text
*/
char *
gtk_entry_get_icon_tooltip_text (GtkEntry *entry,
* gtk_entry_set_icon_tooltip_text:
* @entry: a `GtkEntry`
* @icon_pos: the icon position
- * @tooltip: (nullable): the contents of the tooltip for the
- * icon, or %NULL
+ * @tooltip: (nullable): the contents of the tooltip for the icon
*
* Sets @tooltip as the contents of the tooltip for the icon
* at the specified position.
* Gets the contents of the tooltip on the icon at the specified
* position in @entry.
*
- * Returns: (nullable): the tooltip text, or %NULL. Free the
- * returned string with g_free() when done.
+ * Returns: (nullable) (transfer full): the tooltip text
*/
char *
gtk_entry_get_icon_tooltip_markup (GtkEntry *entry,
* gtk_entry_set_icon_tooltip_markup:
* @entry: a `GtkEntry`
* @icon_pos: the icon position
- * @tooltip: (nullable): the contents of the tooltip for the
- * icon, or %NULL
+ * @tooltip: (nullable): the contents of the tooltip for the icon
*
* Sets @tooltip as the contents of the tooltip for the icon at
* the specified position.
/**
* gtk_entry_set_completion: (attributes org.gtk.Method.set_property=completion)
* @entry: A `GtkEntry`
- * @completion: (nullable): The `GtkEntryCompletion` or %NULL
+ * @completion: (nullable): The `GtkEntryCompletion`
*
* Sets @completion to be the auxiliary completion object
* to use with @entry.
/**
* gtk_entry_set_placeholder_text: (attributes org.gtk.Method.set_property=placeholder-text)
* @entry: a `GtkEntry`
- * @text: (nullable): a string to be displayed when @entry is
- * empty and unfocused, or %NULL
+ * @text: (nullable): a string to be displayed when @entry is empty and unfocused
*
* Sets text to be displayed in @entry when it is empty.
*
*
* See [method@Gtk.Entry.set_attributes].
*
- * Returns: (transfer none) (nullable): the attribute list,
- * or %NULL if none was set.
+ * Returns: (transfer none) (nullable): the attribute list
*/
PangoAttrList *
gtk_entry_get_attributes (GtkEntry *entry)
*
* See [method@Gtk.Entry.set_tabs].
*
- * Returns: (nullable) (transfer none): the tabstops,
- * or %NULL if none was set.
+ * Returns: (nullable) (transfer none): the tabstops
*/
PangoTabArray *
/**
* gtk_entry_buffer_new:
- * @initial_chars: (nullable): initial buffer text, or %NULL
+ * @initial_chars: (nullable): initial buffer text
* @n_initial_chars: number of characters in @initial_chars, or -1
*
* Create a new `GtkEntryBuffer` object.
*
* Returns %NULL if the model is unset.
*
- * Returns: (nullable) (transfer none): A `GtkTreeModel`, or %NULL if none
- * is currently being used
+ * Returns: (nullable) (transfer none): A `GtkTreeModel`
*/
GtkTreeModel *
gtk_entry_completion_get_model (GtkEntryCompletion *completion)
* see [method@Gtk.EntryCompletion.set_text_column] for details.
*
* Returns: (nullable) (transfer full): The common prefix all rows
- * starting with @key or %NULL if no row matches @key.
+ * starting with @key
*/
char *
gtk_entry_completion_compute_prefix (GtkEntryCompletion *completion,
*
* Retrieves the label widget for the frame.
*
- * Returns: (nullable) (transfer none): the label widget,
- * or %NULL if there is none
+ * Returns: (nullable) (transfer none): the label widget
*/
GtkWidget *
gtk_expander_get_label_widget (GtkExpander *expander)
* gtk_file_chooser_set_current_folder:
* @chooser: a `GtkFileChooser`
* @file: the `GFile` for the new folder
- * @error: location to store error, or %NULL.
+ * @error: location to store error
*
* Sets the current folder for @chooser from a #GFile.
*
* gtk_file_chooser_set_file:
* @chooser: a `GtkFileChooser`
* @file: the `GFile` to set as current
- * @error: (nullable): location to store the error, or %NULL to ignore errors.
+ * @error: (nullable): location to store the error
*
* Sets @file as the current filename for the file chooser.
*
* gtk_file_chooser_add_shortcut_folder:
* @chooser: a `GtkFileChooser`
* @folder: a `GFile` for the folder to add
- * @error: location to store error, or %NULL
+ * @error: location to store error
*
* Adds a folder to be displayed with the shortcut folders
* in a file chooser.
* gtk_file_chooser_remove_shortcut_folder:
* @chooser: a `GtkFileChooser`
* @folder: a `GFile` for the folder to remove
- * @error: location to store error, or %NULL
+ * @error: location to store error
*
* Removes a folder from the shortcut folders in a file chooser.
*
*
* Gets the current filter.
*
- * Returns: (nullable) (transfer none): the current filter, or %NULL
+ * Returns: (nullable) (transfer none): the current filter
*/
GtkFileFilter *
gtk_file_chooser_get_filter (GtkFileChooser *chooser)
/**
* gtk_file_chooser_dialog_new:
- * @title: (nullable): Title of the dialog, or %NULL
- * @parent: (nullable): Transient parent of the dialog, or %NULL
+ * @title: (nullable): Title of the dialog
+ * @parent: (nullable): Transient parent of the dialog
* @action: Open or save mode for the dialog
- * @first_button_text: (nullable): text to go in the first button, or %NULL
+ * @first_button_text: (nullable): text to go in the first button
* @...: response ID for the first button, then additional (button, id) pairs, ending with %NULL
*
* Creates a new `GtkFileChooserDialog`.
* be different. If the user has entered unparsable text, or text which
* the entry cannot handle, this will return %NULL.
*
- * Returns: (nullable): the file for the current folder or %NULL if the
- * current folder can not be determined. Unref the file with
- * g_object_unref() after use.
- **/
+ * Returns: (nullable) (transfer full): the file for the current folder
+ * or %NULL if the current folder can not be determined
+ */
GFile *
_gtk_file_chooser_entry_get_current_folder (GtkFileChooserEntry *chooser_entry)
{
*
* Retrieves the custom label text for the accept button.
*
- * Returns: (nullable): The custom label, or %NULL for the default.
- * This string is owned by GTK and should not be modified or freed
+ * Returns: (nullable): The custom label
*/
const char *
gtk_file_chooser_native_get_accept_label (GtkFileChooserNative *self)
/**
* gtk_file_chooser_native_set_accept_label: (attributes org.gtk.Method.set_property=accept-label)
* @self: a `GtkFileChooserNative`
- * @accept_label: (nullable): custom label or %NULL for the default
+ * @accept_label: (nullable): custom label
*
* Sets the custom label text for the accept button.
*
*
* Retrieves the custom label text for the cancel button.
*
- * Returns: (nullable): The custom label, or %NULL for the default.
- * This string is owned by GTK and should not be modified or freed
+ * Returns: (nullable): The custom label
*/
const char *
gtk_file_chooser_native_get_cancel_label (GtkFileChooserNative *self)
/**
* gtk_file_chooser_native_set_cancel_label: (attributes org.gtk.Method.set_property=cancel-label)
* @self: a `GtkFileChooserNative`
- * @cancel_label: (nullable): custom label or %NULL for the default
+ * @cancel_label: (nullable): custom label
*
* Sets the custom label text for the cancel button.
*
/**
* gtk_file_chooser_native_new:
- * @title: (nullable): Title of the native, or %NULL
- * @parent: (nullable): Transient parent of the native, or %NULL
+ * @title: (nullable): Title of the native
+ * @parent: (nullable): Transient parent of the native
* @action: Open or save mode for the dialog
* @accept_label: (nullable): text to go in the accept button, or %NULL for the default
* @cancel_label: (nullable): text to go in the cancel button, or %NULL for the default
*
* See [method@Gtk.FileFilter.set_name].
*
- * Returns: (nullable): The human-readable name of the filter,
- * or %NULL. This value is owned by GTK and must not
- * be modified or freed.
+ * Returns: (nullable): The human-readable name of the filter
*/
const char *
gtk_file_filter_get_name (GtkFileFilter *filter)
*
* Returns: a pointer to the actual value as stored in @model or %NULL
* if no value available yet
- **/
+ */
const GValue *
_gtk_file_system_model_get_value (GtkFileSystemModel *model,
GtkTreeIter * iter,
/**
* gtk_filter_list_model_new:
- * @model: (nullable) (transfer full): the model to sort, or %NULL
- * @filter: (nullable) (transfer full): filter or %NULL to not filter items
+ * @model: (nullable) (transfer full): the model to sort
+ * @filter: (nullable) (transfer full): filter
*
* Creates a new `GtkFilterListModel` that will filter @model using the given
* @filter.
/**
* gtk_filter_list_model_set_filter: (attributes org.gtk.Method.set_property=filter)
* @self: a `GtkFilterListModel`
- * @filter: (nullable) (transfer none): filter to use or %NULL to not filter items
+ * @filter: (nullable) (transfer none): filter to use
*
* Sets the filter used to filter items.
**/
* gtk_fixed_set_child_transform:
* @fixed: a `GtkFixed`
* @widget: a `GtkWidget`, child of @fixed
- * @transform: (nullable): the transformation assigned to @widget or %NULL
+ * @transform: (nullable): the transformation assigned to @widget
* to reset @widget's transform
*
* Sets the transformation for @widget.
* Retrieves the transformation for @widget set using
* gtk_fixed_set_child_transform().
*
- * Returns: (transfer none) (nullable): a `GskTransform` or %NULL
- * in case no transform has been set on @widget
+ * Returns: (transfer none) (nullable): a `GskTransform`
*/
GskTransform *
gtk_fixed_get_child_transform (GtkFixed *fixed,
/**
* gtk_flatten_list_model_set_model: (attributes org.gtk.Method.set_property=model)
* @self: a `GtkFlattenListModel`
- * @model: (nullable) (transfer none): the new model or %NULL
+ * @model: (nullable) (transfer none): the new model
*
* Sets a new model to be flattened.
*/
* If the selected font is not installed, returns %NULL.
*
* Returns: (nullable) (transfer none): A `PangoFontFamily` representing the
- * selected font family, or %NULL. The returned object is owned by @fontchooser
- * and must not be modified or freed.
+ * selected font family
*/
PangoFontFamily *
gtk_font_chooser_get_font_family (GtkFontChooser *fontchooser)
* If the selected font is not installed, returns %NULL.
*
* Returns: (nullable) (transfer none): A `PangoFontFace` representing the
- * selected font group details, or %NULL. The returned object is owned by
- * @fontchooser and must not be modified or freed.
+ * selected font group details
*/
PangoFontFace *
gtk_font_chooser_get_font_face (GtkFontChooser *fontchooser)
* font descriptions.
*
* Returns: (nullable) (transfer full): A string with the name
- * of the current font, or %NULL if no font is selected. You must
- * free this string with g_free().
+ * of the current font
*/
char *
gtk_font_chooser_get_font (GtkFontChooser *fontchooser)
* font descriptions.
*
* Returns: (nullable) (transfer full): A `PangoFontDescription` for the
- * current font, or %NULL if no font is selected.
+ * current font
*/
PangoFontDescription *
gtk_font_chooser_get_font_desc (GtkFontChooser *fontchooser)
/**
* gtk_font_chooser_set_filter_func:
* @fontchooser: a `GtkFontChooser`
- * @filter: (nullable): a `GtkFontFilterFunc`, or %NULL
+ * @filter: (nullable): a `GtkFontFilterFunc`
* @user_data: (closure): data to pass to @filter
* @destroy: function to call to free @data when it is no longer needed
*
* Gets the custom font map of this font chooser widget,
* or %NULL if it does not have one.
*
- * Returns: (nullable) (transfer full): a `PangoFontMap`, or %NULL
+ * Returns: (nullable) (transfer full): a `PangoFontMap`
*/
PangoFontMap *
gtk_font_chooser_get_font_map (GtkFontChooser *fontchooser)
/**
* gtk_font_chooser_dialog_new:
- * @title: (nullable): Title of the dialog, or %NULL
- * @parent: (nullable): Transient parent of the dialog, or %NULL
+ * @title: (nullable): Title of the dialog
+ * @parent: (nullable): Transient parent of the dialog
*
* Creates a new `GtkFontChooserDialog`.
*
*
* Retrieves the label widget for the frame.
*
- * Returns: (nullable) (transfer none): the label widget, or %NULL if
- * there is none.
+ * Returns: (nullable) (transfer none): the label widget
*/
GtkWidget *
gtk_frame_get_label_widget (GtkFrame *frame)
*
* This returns %NULL if the gesture is not being interacted.
*
- * Returns: (nullable) (transfer none): a `GdkDevice`, or %NULL
+ * Returns: (nullable) (transfer none): a `GdkDevice`
*/
GdkDevice *
gtk_gesture_get_device (GtkGesture *gesture)
/**
* gtk_gesture_handles_sequence:
* @gesture: a `GtkGesture`
- * @sequence: (nullable): a `GdkEventSequence` or %NULL
+ * @sequence: (nullable): a `GdkEventSequence`
*
* Returns %TRUE if @gesture is currently handling events
* corresponding to @sequence.
*
* Gets the current error set on the @area.
*
- * Returns: (nullable) (transfer none): the #GError or %NULL
+ * Returns: (nullable) (transfer none): the #GError
*/
GError *
gtk_gl_area_get_error (GtkGLArea *area)
* Gets the child of @grid whose area covers the grid
* cell at @column, @row.
*
- * Returns: (transfer none) (nullable): the child at the given position, or %NULL
+ * Returns: (transfer none) (nullable): the child at the given position
*/
GtkWidget *
gtk_grid_get_child_at (GtkGrid *grid,
* In particular that means that for an empty grid, %NULL is returned
* for any value.
*
- * Returns: (nullable): The first cell at offset y or %NULL if none
+ * Returns: (nullable): The first cell at offset y
**/
static Cell *
gtk_grid_view_get_cell_at_y (GtkGridView *self,
/**
* gtk_grid_view_new:
- * @model: (nullable) (transfer full): the model to use, or %NULL
- * @factory: (nullable) (transfer full): The factory to populate items with, or %NULL
+ * @model: (nullable) (transfer full): the model to use
+ * @factory: (nullable) (transfer full): The factory to populate items with
*
* Creates a new `GtkGridView` that uses the given @factory for
* mapping items to widgets.
/**
* gtk_grid_view_set_model: (attributes org.gtk.Method.set_property=model)
* @self: a `GtkGridView`
- * @model: (nullable) (transfer none): the model to use or %NULL for none
+ * @model: (nullable) (transfer none): the model to use
*
* Sets the imodel to use.
*
/**
* gtk_grid_view_set_factory: (attributes org.gtk.Method.set_property=factory)
* @self: a `GtkGridView`
- * @factory: (nullable) (transfer none): the factory to use or %NULL for none
+ * @factory: (nullable) (transfer none): the factory to use
*
* Sets the `GtkListItemFactory` to use for populating list items.
*/
*
* See [method@Gtk.HeaderBar.set_title_widget].
*
- * Returns: (nullable) (transfer none): the title widget
- * of the header, or %NULL if none has been set explicitly.
+ * Returns: (nullable) (transfer none): the title widget of the header
*/
GtkWidget *
gtk_header_bar_get_title_widget (GtkHeaderBar *bar)
/**
* gtk_header_bar_set_decoration_layout: (attributes org.gtk.Method.set_property=decoration-layout)
* @bar: a `GtkHeaderBar`
- * @layout: (nullable): a decoration layout, or %NULL to
- * unset the layout
+ * @layout: (nullable): a decoration layout, or %NULL to unset the layout
*
* Sets the decoration layout for this header bar.
*
* See [method@Gtk.IconTheme.set_search_path].
*
* Returns: (transfer full) (array zero-terminated=1) (element-type filename) (nullable):
- * a list of icon theme path directories or %NULL.
- * The returned value should be freed with g_strfreev().
+ * a list of icon theme path directories
*/
char **
gtk_icon_theme_get_search_path (GtkIconTheme *self)
* See [method@Gtk.IconTheme.set_resource_path].
*
* Returns: (transfer full) (array zero-terminated=1) (element-type utf8) (nullable):
- * A list of resource paths or %NULL.
- * The returned value should be freed with g_strfreev().
+ * A list of resource paths
*/
char **
gtk_icon_theme_get_resource_path (GtkIconTheme *self)
*
* Returns %NULL if the icon was not loaded from a file.
*
- * Returns: (nullable) (transfer full): the #GFile for the icon, or %NULL.
- * Free with g_object_unref().
+ * Returns: (nullable) (transfer full): the #GFile for the icon
*/
GFile *
gtk_icon_paintable_get_file (GtkIconPaintable *icon)
* gtk_icon_view_set_cursor:
* @icon_view: A #GtkIconView
* @path: A #GtkTreePath
- * @cell: (nullable): One of the cell renderers of @icon_view, or %NULL
+ * @cell: (nullable): One of the cell renderers of @icon_view
* @start_editing: %TRUE if the specified cell should start being edited.
*
* Sets the current keyboard focus to be at @path, and selects it. This is
* @icon_view: A #GtkIconView.
* @x: The x position to be identified
* @y: The y position to be identified
- * @path: (out) (optional): Return location for the path, or %NULL
+ * @path: (out) (optional): Return location for the path
* @cell: (out) (optional) (transfer none): Return location for the renderer
- * responsible for the cell at (@x, @y), or %NULL
+ * responsible for the cell at (@x, @y)
*
* Gets the path and cell for the icon at the given position.
*
* gtk_icon_view_get_cell_rect:
* @icon_view: a #GtkIconView
* @path: a #GtkTreePath
- * @cell: (nullable): a #GtkCellRenderer or %NULL
+ * @cell: (nullable): a #GtkCellRenderer
* @rect: (out): rectangle to fill with cell rect
*
* Fills the bounding rectangle in widget coordinates for the cell specified by
* @icon_view: a #GtkIconView
* @tooltip: a #GtkTooltip
* @path: a #GtkTreePath
- * @cell: (nullable): a #GtkCellRenderer or %NULL
+ * @cell: (nullable): a #GtkCellRenderer
*
* Sets the tip area of @tooltip to the area which @cell occupies in
* the item pointed to by @path. See also gtk_tooltip_set_tip_area().
/**
* gtk_icon_view_set_drag_dest_item:
* @icon_view: a #GtkIconView
- * @path: (nullable): The path of the item to highlight, or %NULL.
+ * @path: (nullable): The path of the item to highlight
* @pos: Specifies where to drop, relative to the item
*
* Sets the item that is highlighted for feedback.
* @icon_view: a #GtkIconView
* @drag_x: the position to determine the destination item for
* @drag_y: the position to determine the destination item for
- * @path: (out) (optional): Return location for the path of the item,
- * or %NULL.
- * @pos: (out) (optional): Return location for the drop position, or %NULL
+ * @path: (out) (optional): Return location for the path of the item
+ * @pos: (out) (optional): Return location for the drop position
*
* Determines the destination item for a given position.
*
/**
* gtk_image_new_from_pixbuf:
- * @pixbuf: (nullable): a `GdkPixbuf`, or %NULL
+ * @pixbuf: (nullable): a `GdkPixbuf`
*
* Creates a new `GtkImage` displaying @pixbuf.
*
/**
* gtk_image_new_from_paintable:
- * @paintable: (nullable): a `GdkPaintable`, or %NULL
+ * @paintable: (nullable): a `GdkPaintable`
*
* Creates a new `GtkImage` displaying @paintable.
*
/**
* gtk_image_new_from_icon_name:
- * @icon_name: (nullable): an icon name or %NULL
+ * @icon_name: (nullable): an icon name
*
* Creates a `GtkImage` displaying an icon from the current icon theme.
*
/**
* gtk_image_set_from_file: (attributes org.gtk.Method.set_property=file)
* @image: a `GtkImage`
- * @filename: (type filename) (nullable): a filename or %NULL
+ * @filename: (type filename) (nullable): a filename
*
* Sets a `GtkImage` to show a file.
*
/**
* gtk_image_set_from_resource: (attributes org.gtk.Method.set_property=resource)
* @image: a `GtkImage`
- * @resource_path: (nullable): a resource path or %NULL
+ * @resource_path: (nullable): a resource path
*
* Sets a `GtkImage` to show a resource.
*
/**
* gtk_image_set_from_icon_name: (attributes org.gtk.Method.set_property=icon-name)
* @image: a `GtkImage`
- * @icon_name: (nullable): an icon name or %NULL
+ * @icon_name: (nullable): an icon name
*
* Sets a `GtkImage` to show a named icon.
*
/**
* gtk_image_set_from_paintable: (attributes org.gtk.Method.set_property=paintable)
* @image: a `GtkImage`
- * @paintable: (nullable): a `GdkPaintable` or %NULL
+ * @paintable: (nullable): a `GdkPaintable`
*
* Sets a `GtkImage` to show a `GdkPaintable`.
*
* The caller of this function does not own a reference to the
* returned paintable.
*
- * Returns: (nullable) (transfer none): the displayed paintable,
- * or %NULL if the image is empty
+ * Returns: (nullable) (transfer none): the displayed paintable
*/
GdkPaintable *
gtk_image_get_paintable (GtkImage *image)
* The returned string is owned by the `GtkImage` and should not
* be freed.
*
- * Returns: (transfer none) (nullable): the icon name, or %NULL
+ * Returns: (transfer none) (nullable): the icon name
*/
const char *
gtk_image_get_icon_name (GtkImage *image)
* The caller of this function does not own a reference to the
* returned `GIcon`.
*
- * Returns: (transfer none) (nullable): a `GIcon`, or %NULL
+ * Returns: (transfer none) (nullable): a `GIcon`
**/
GIcon *
gtk_image_get_gicon (GtkImage *image)
/**
* gtk_info_bar_new_with_buttons:
- * @first_button_text: (nullable): ext to go in first button, or %NULL
+ * @first_button_text: (nullable): ext to go in first button
* @...: response ID for first button, then additional buttons, ending
* with %NULL
*
/**
* gtk_label_set_attributes: (attributes org.gtk.Method.set_property=attributes)
* @self: a `GtkLabel`
- * @attrs: (nullable): a [struct@Pango.AttrList], or %NULL
+ * @attrs: (nullable): a [struct@Pango.AttrList]
*
* Apply attributes to the label text.
*
* attributes for the label, use
* `pango_layout_get_attribute (gtk_label_get_layout (self))`.
*
- * Returns: (nullable) (transfer none): the attribute list, or %NULL
- * if none was set.
+ * Returns: (nullable) (transfer none): the attribute list
*/
PangoAttrList *
gtk_label_get_attributes (GtkLabel *self)
/**
* gtk_label_get_layout_offsets:
* @self: a `GtkLabel`
- * @x: (out) (optional): location to store X offset of layout, or %NULL
- * @y: (out) (optional): location to store Y offset of layout, or %NULL
+ * @x: (out) (optional): location to store X offset of layout
+ * @y: (out) (optional): location to store Y offset of layout
*
* Obtains the coordinates where the label will draw its `PangoLayout`.
*
* This function is intended for use in a [signal@Gtk.Label::activate-link]
* handler or for use in a [signal@Gtk.Widget::query-tooltip] handler.
*
- * Returns: (nullable): the currently active URI or %NULL if there is none.
- * The string is owned by GTK and must not be freed or modified.
+ * Returns: (nullable): the currently active URI
*/
const char *
gtk_label_get_current_uri (GtkLabel *self)
* case you should use [method@Gtk.ListBox.selected_foreach] to
* find all selected rows.
*
- * Returns: (transfer none) (nullable): the selected row or %NULL
+ * Returns: (transfer none) (nullable): the selected row
*/
GtkListBoxRow *
gtk_list_box_get_selected_row (GtkListBox *box)
* If @index_ is negative or larger than the number of items in the
* list, %NULL is returned.
*
- * Returns: (transfer none) (nullable): the child `GtkWidget` or %NULL
+ * Returns: (transfer none) (nullable): the child `GtkWidget`
*/
GtkListBoxRow *
gtk_list_box_get_row_at_index (GtkListBox *box,
*
* Gets the row at the @y position.
*
- * Returns: (transfer none) (nullable): the row or %NULL
- * in case no row exists for the given y coordinate.
+ * Returns: (transfer none) (nullable): the row
*/
GtkListBoxRow *
gtk_list_box_get_row_at_y (GtkListBox *box,
/**
* gtk_list_box_select_row:
* @box: a `GtkListBox`
- * @row: (nullable): The row to select or %NULL
+ * @row: (nullable): The row to select
*
* Make @row the currently selected row.
*/
/**
* gtk_list_box_set_placeholder:
* @box: a `GtkListBox`
- * @placeholder: (nullable): a #GtkWidget or %NULL
+ * @placeholder: (nullable): a #GtkWidget
*
* Sets the placeholder widget that is shown in the list when
* it doesn't display any visible children.
/**
* gtk_list_box_set_adjustment:
* @box: a `GtkListBox`
- * @adjustment: (nullable): the adjustment, or %NULL
+ * @adjustment: (nullable): the adjustment
*
* Sets the adjustment (if any) that the widget uses to
* for vertical scrolling.
* there is a header set already, and if so to update
* the state of it.
*
- * Returns: (transfer none) (nullable): the current header, or %NULL if none
+ * Returns: (transfer none) (nullable): the current header
*/
GtkWidget *
gtk_list_box_row_get_header (GtkListBoxRow *row)
/**
* gtk_list_box_row_set_header:
* @row: a `GtkListBoxRow`
- * @header: (nullable): the header, or %NULL
+ * @header: (nullable): the header
*
* Sets the current header of the @row.
*
* gtk_list_store_insert_before:
* @list_store: A #GtkListStore
* @iter: (out): An unset #GtkTreeIter to set to the new row
- * @sibling: (nullable): A valid #GtkTreeIter, or %NULL
+ * @sibling: (nullable): A valid #GtkTreeIter
*
* Inserts a new row before @sibling. If @sibling is %NULL, then the row will
* be appended to the end of the list. @iter will be changed to point to this
* gtk_list_store_insert_after:
* @list_store: A #GtkListStore
* @iter: (out): An unset #GtkTreeIter to set to the new row
- * @sibling: (nullable): A valid #GtkTreeIter, or %NULL
+ * @sibling: (nullable): A valid #GtkTreeIter
*
* Inserts a new row after @sibling. If @sibling is %NULL, then the row will be
* prepended to the beginning of the list. @iter will be changed to point to
* gtk_list_store_move_before:
* @store: A #GtkListStore.
* @iter: A #GtkTreeIter.
- * @position: (nullable): A #GtkTreeIter, or %NULL.
+ * @position: (nullable): A #GtkTreeIter
*
* Moves @iter in @store to the position before @position. Note that this
* function only works with unsorted stores. If @position is %NULL, @iter
* gtk_list_store_move_after:
* @store: A #GtkListStore.
* @iter: A #GtkTreeIter.
- * @position: (nullable): A #GtkTreeIter or %NULL.
+ * @position: (nullable): A #GtkTreeIter
*
* Moves @iter in @store to the position after @position. Note that this
* function only works with unsorted stores. If @position is %NULL, @iter
/**
* gtk_list_view_new:
- * @model: (nullable) (transfer full): the model to use, or %NULL
- * @factory: (nullable) (transfer full): The factory to populate items with, or %NULL
+ * @model: (nullable) (transfer full): the model to use
+ * @factory: (nullable) (transfer full): The factory to populate items with
*
* Creates a new `GtkListView` that uses the given @factory for
* mapping items to widgets.
/**
* gtk_list_view_set_model: (attributes org.gtk.Method.set_property=model)
* @self: a `GtkListView`
- * @model: (nullable) (transfer none): the model to use or %NULL for none
+ * @model: (nullable) (transfer none): the model to use
*
* Sets the model to use.
*
/**
* gtk_list_view_set_factory: (attributes org.gtk.Method.set_property=factory)
* @self: a `GtkListView`
- * @factory: (nullable) (transfer none): the factory to use or %NULL for none
+ * @factory: (nullable) (transfer none): the factory to use
*
* Sets the `GtkListItemFactory` to use for populating list items.
*/
/**
* gtk_lock_button_set_permission: (attributes org.gtk.Method.set_property=permission)
* @button: a `GtkLockButton`
- * @permission: (nullable): a `GPermission` object, or %NULL
+ * @permission: (nullable): a `GPermission` object
*
* Sets the `GPermission` object that controls @button.
*/
* originally.
*
* Returns: (transfer none) (nullable): the widget that originally
- * received @event, or %NULL
+ * received @event
*/
GtkWidget *
gtk_get_event_widget (GdkEvent *event)
/**
* gtk_map_list_model_new:
- * @model: (transfer full) (nullable): The model to map or %NULL for none
- * @map_func: (nullable): map function or %NULL to not map items
+ * @model: (transfer full) (nullable): The model to map
+ * @map_func: (nullable): map function
* @user_data: (closure): user data passed to @map_func
* @user_destroy: destroy notifier for @user_data
*
/**
* gtk_map_list_model_set_map_func:
* @self: a `GtkMapListModel`
- * @map_func: (nullable): map function or %NULL to not map items
+ * @map_func: (nullable): map function
* @user_data: (closure): user data passed to @map_func
* @user_destroy: destroy notifier for @user_data
*
/**
* gtk_media_controls_set_media_stream: (attributes org.gtk.Method.set_property=media-stream)
* @controls: a `GtkMediaControls` widget
- * @stream: (nullable): a `GtkMediaStream`, or %NULL
+ * @stream: (nullable): a `GtkMediaStream`
*
* Sets the stream that is controlled by @controls.
*/
* %NULL is returned.
*
* Returns: (nullable) (transfer none): The currently playing file
- * or %NULL if not playing from a file.
*/
GFile *
gtk_media_file_get_file (GtkMediaFile *self)
* When @self is not playing or not playing from a stream,
* %NULL is returned.
*
- * Returns: (nullable) (transfer none): The currently playing
- * stream or %NULL if not playing from a stream.
+ * Returns: (nullable) (transfer none): The currently playing stream
*/
GInputStream *
gtk_media_file_get_input_stream (GtkMediaFile *self)
*
* Returns the `GMenuModel` used to generate the popup.
*
- * Returns: (nullable) (transfer none): a `GMenuModel` or %NULL
+ * Returns: (nullable) (transfer none): a `GMenuModel`
*/
GMenuModel *
gtk_menu_button_get_menu_model (GtkMenuButton *menu_button)
/**
* gtk_message_dialog_new:
- * @parent: (nullable): transient parent, or %NULL for none
+ * @parent: (nullable): transient parent
* @flags: flags
* @type: type of message
* @buttons: set of buttons to use
- * @message_format: (nullable): printf()-style format string, or %NULL
+ * @message_format: (nullable): printf()-style format string
* @...: arguments for @message_format
*
* Creates a new message dialog.
/**
* gtk_message_dialog_new_with_markup:
- * @parent: (nullable): transient parent, or %NULL for none
+ * @parent: (nullable): transient parent
* @flags: flags
* @type: type of message
* @buttons: set of buttons to use
- * @message_format: (nullable): printf()-style format string, or %NULL
+ * @message_format: (nullable): printf()-style format string
* @...: arguments for @message_format
*
* Creates a new message dialog.
/**
* gtk_message_dialog_format_secondary_text:
* @message_dialog: a `GtkMessageDialog`
- * @message_format: (nullable): printf()-style format string, or %NULL
+ * @message_format: (nullable): printf()-style format string
* @...: arguments for @message_format
*
* Sets the secondary text of the message dialog.
/**
* gtk_mount_operation_new:
- * @parent: (nullable): transient parent of the window, or %NULL
+ * @parent: (nullable): transient parent of the window
*
* Creates a new `GtkMountOperation`.
*
/**
* gtk_mount_operation_set_parent: (attributes org.gtk.Method.set_property=parent)
* @op: a `GtkMountOperation`
- * @parent: (nullable): transient parent of the window, or %NULL
+ * @parent: (nullable): transient parent of the window
*
* Sets the transient parent for windows shown by the
* `GtkMountOperation`.
/**
* gtk_multi_selection_new:
- * @model: (nullable) (transfer full): the `GListModel` to manage, or %NULL
+ * @model: (nullable) (transfer full): the `GListModel` to manage
*
* Creates a new selection to handle @model.
*
/**
* gtk_native_dialog_set_transient_for: (attributes org.gtk.Method.set_property=transient-for)
* @self: a `GtkNativeDialog`
- * @parent: (nullable): parent window, or %NULL
+ * @parent: (nullable): parent window
*
* Dialog windows should be set transient for the main application
* window they were spawned from.
/**
* gtk_no_selection_new:
- * @model: (nullable) (transfer full): the `GListModel` to manage, or %NULL
+ * @model: (nullable) (transfer full): the `GListModel` to manage
*
* Creates a new selection to handle @model.
*
* necessary properties to the notebook (e.g. the
* `GtkNotebook`:group-name ).
*
- * Returns: (transfer none): a `GtkNotebook` that @page should be
- * added to, or %NULL.
+ * Returns: (nullable) (transfer none): a `GtkNotebook` that
+ * @page should be added to
*/
notebook_signals[CREATE_WINDOW] =
g_signal_new (I_("create-window"),
*
* Gets the expression that is evaluated to obtain numbers from items.
*
- * Returns: (transfer none) (nullable): a `GtkExpression`, or %NULL
+ * Returns: (transfer none) (nullable): a `GtkExpression`
*/
GtkExpression *
gtk_numeric_sorter_get_expression (GtkNumericSorter *self)
/**
* gtk_numeric_sorter_set_expression: (attributes org.gtk.Method.set_property=expression)
* @self: a `GtkNumericSorter`
- * @expression: (nullable) (transfer none): a `GtkExpression`, or %NULL
+ * @expression: (nullable) (transfer none): a `GtkExpression`
*
* Sets the expression that is evaluated to obtain numbers from items.
*
* gtk_page_setup_load_file:
* @setup: a `GtkPageSetup`
* @file_name: (type filename): the filename to read the page setup from
- * @error: (nullable): return location for an error, or %NULL
+ * @error: (nullable): return location for an error
*
* Reads the page setup from the file @file_name.
*
/**
* gtk_page_setup_new_from_file:
* @file_name: (type filename): the filename to read the page setup from
- * @error: (nullable): return location for an error, or %NULL
+ * @error: (nullable): return location for an error
*
* Reads the page setup from the file @file_name.
*
* gtk_page_setup_load_key_file:
* @setup: a `GtkPageSetup`
* @key_file: the `GKeyFile` to retrieve the page_setup from
- * @group_name: (nullable): the name of the group in the key_file to read, or %NULL
+ * @group_name: (nullable): the name of the group in the key_file to read
* to use the default name “Page Setup”
- * @error: (nullable): return location for an error, or %NULL
+ * @error: (nullable): return location for an error
*
* Reads the page setup from the group @group_name in the key file
* @key_file.
/**
* gtk_page_setup_new_from_key_file:
* @key_file: the `GKeyFile` to retrieve the page_setup from
- * @group_name: (nullable): the name of the group in the key_file to read, or %NULL
+ * @group_name: (nullable): the name of the group in the key_file to read
* to use the default name “Page Setup”
- * @error: (nullable): return location for an error, or %NULL
+ * @error: (nullable): return location for an error
*
* Reads the page setup from the group @group_name in the key file
* @key_file.
* gtk_page_setup_to_file:
* @setup: a `GtkPageSetup`
* @file_name: (type filename): the file to save to
- * @error: (nullable): return location for errors, or %NULL
+ * @error: (nullable): return location for errors
*
* This function saves the information from @setup to @file_name.
*
/**
* gtk_page_setup_unix_dialog_new:
- * @title: (nullable): the title of the dialog, or %NULL
- * @parent: (nullable): transient parent of the dialog, or %NULL
+ * @title: (nullable): the title of the dialog
+ * @parent: (nullable): transient parent of the dialog
*
* Creates a new page setup dialog.
*
/*
* _gtk_pango_attr_list_merge:
- * @into: a #PangoAttrList where attributes are merged or %NULL
- * @from: a #PangoAttrList with the attributes to merge or %NULL
+ * @into: (nullable): a #PangoAttrList where attributes are merged
+ * @from: (nullable): a #PangoAttrList with the attributes to merge
*
* Merges attributes from @from into @into.
*
/**
* gtk_paper_size_new:
- * @name: (nullable): a paper size name, or %NULL
+ * @name: (nullable): a paper size name
*
* Creates a new `GtkPaperSize` object by parsing a
* [PWG 5101.1-2002](ftp://ftp.pwg.org/pub/pwg/candidates/cs-pwgmsn10-20020226-5101.1.pdf)
* @key_file: the `GKeyFile` to retrieve the papersize from
* @group_name: (nullable): the name of the group in the key file to read,
* or %NULL to read the first group
- * @error: (nullable): return location for an error, or %NULL
+ * @error: (nullable): return location for an error
*
* Reads a paper size from the group @group_name in the key file
* @key_file.
*
- * Returns: a new `GtkPaperSize` object with the restored
- * paper size, or %NULL if an error occurred
+ * Returns: a new `GtkPaperSize` object with the restored paper size
*/
GtkPaperSize *
gtk_paper_size_new_from_key_file (GKeyFile *key_file,
/**
* gtk_picture_new_for_paintable:
- * @paintable: (nullable): a `GdkPaintable`, or %NULL
+ * @paintable: (nullable): a `GdkPaintable`
*
* Creates a new `GtkPicture` displaying @paintable.
*
/**
* gtk_picture_new_for_pixbuf:
- * @pixbuf: (nullable): a `GdkPixbuf`, or %NULL
+ * @pixbuf: (nullable): a `GdkPixbuf`
*
* Creates a new `GtkPicture` displaying @pixbuf.
*
/**
* gtk_picture_set_file: (attributes org.gtk.Method.set_property=file)
* @self: a `GtkPicture`
- * @file: (nullable): a `GFile` or %NULL
+ * @file: (nullable): a `GFile`
*
* Makes @self load and display @file.
*
/**
* gtk_picture_set_pixbuf:
* @self: a `GtkPicture`
- * @pixbuf: (nullable): a `GdkPixbuf` or %NULL
+ * @pixbuf: (nullable): a `GdkPixbuf`
*
* Sets a `GtkPicture` to show a `GdkPixbuf`.
*
/**
* gtk_picture_set_paintable: (attributes org.gtk.Method.set_property=paintable)
* @self: a `GtkPicture`
- * @paintable: (nullable): a `GdkPaintable` or %NULL
+ * @paintable: (nullable): a `GdkPaintable`
*
* Makes @self display the given @paintable.
*
*
* Gets the `GdkPaintable` being displayed by the `GtkPicture`.
*
- * Returns: (nullable) (transfer none): the displayed paintable, or %NULL if
- * the picture is empty
+ * Returns: (nullable) (transfer none): the displayed paintable
*/
GdkPaintable *
gtk_picture_get_paintable (GtkPicture *self)
/**
* gtk_popover_menu_new_from_model:
- * @model: (nullable): a `GMenuModel`, or %NULL
+ * @model: (nullable): a `GMenuModel`
*
* Creates a `GtkPopoverMenu` and populates it according to @model.
*
/**
* gtk_popover_menu_set_menu_model: (attributes org.gtk.Method.set_property=menu-model)
* @popover: a `GtkPopoverMenu`
- * @model: (nullable): a `GMenuModel`, or %NULL
+ * @model: (nullable): a `GMenuModel`
*
* Sets a new menu model on @popover.
*
/**
* gtk_popover_menu_bar_new_from_model:
- * @model: (nullable): a `GMenuModel`, or %NULL
+ * @model: (nullable): a `GMenuModel`
*
* Creates a `GtkPopoverMenuBar` from a `GMenuModel`.
*
/**
* gtk_popover_menu_bar_set_menu_model: (attributes org.gtk.Method.set_property=menu-model)
* @bar: a `GtkPopoverMenuBar`
- * @model: (nullable): a `GMenuModel`, or %NULL
+ * @model: (nullable): a `GMenuModel`
*
* Sets a menu model from which @bar should take
* its contents.
/**
* gtk_print_job_get_surface:
* @job: a `GtkPrintJob`
- * @error: (nullable): return location for errors, or %NULL
+ * @error: (nullable): return location for errors
*
* Gets a cairo surface onto which the pages of
* the print job should be rendered.
/**
* gtk_print_run_page_setup_dialog_async:
- * @parent: (nullable): transient parent, or %NULL
- * @page_setup: (nullable): an existing #GtkPageSetup, or %NULL
+ * @parent: (nullable): transient parent
+ * @page_setup: (nullable): an existing #GtkPageSetup
* @settings: a #GtkPrintSettings
* @done_cb: (scope async): a function to call when the user saves
* the modified page setup
* signal is emitted on the operation. Then you can read out any
* information you need from the widgets.
*
- * Returns: (transfer none): A custom widget that gets embedded in
- * the print dialog, or %NULL
+ * Returns: (nullable) (transfer none): A custom widget that gets embedded in
+ * the print dialog
*/
signals[CREATE_CUSTOM_WIDGET] =
g_signal_new (I_("create-custom-widget"),
* @operation: the `GtkPrintOperation` on which the signal was emitted
* @preview: the `GtkPrintOperationPreview` for the current operation
* @context: the `GtkPrintContext` that will be used
- * @parent: (nullable): the `GtkWindow` to use as window parent, or %NULL
+ * @parent: (nullable): the `GtkWindow` to use as window parent
*
* Gets emitted when a preview is requested from the native dialog.
*
/**
* gtk_print_operation_set_default_page_setup: (attributes org.gtk.Method.set_property=default-page-setup)
* @op: a `GtkPrintOperation`
- * @default_page_setup: (nullable): a `GtkPageSetup`, or %NULL
+ * @default_page_setup: (nullable): a `GtkPageSetup`
*
* Makes @default_page_setup the default page setup for @op.
*
* @op: a `GtkPrintOperation`
* @action: the action to start
* @parent: (nullable): Transient parent of the dialog
- * @error: (nullable): Return location for errors, or %NULL
+ * @error: (nullable): Return location for errors
*
* Runs the print operation.
*
* gtk_print_settings_set:
* @settings: a `GtkPrintSettings`
* @key: a key
- * @value: (nullable): a string value, or %NULL
+ * @value: (nullable): a string value
*
* Associates @value with @key.
*/
* gtk_print_settings_load_file:
* @settings: a `GtkPrintSettings`
* @file_name: (type filename): the filename to read the settings from
- * @error: (nullable): return location for errors, or %NULL
+ * @error: (nullable): return location for errors
*
* Reads the print settings from @file_name.
*
/**
* gtk_print_settings_new_from_file:
* @file_name: (type filename): the filename to read the settings from
- * @error: (nullable): return location for errors, or %NULL
+ * @error: (nullable): return location for errors
*
* Reads the print settings from @file_name.
*
* @key_file: the `GKeyFile` to retrieve the settings from
* @group_name: (nullable): the name of the group to use, or %NULL
* to use the default “Print Settings”
- * @error: (nullable): return location for errors, or %NULL
+ * @error: (nullable): return location for errors
*
* Reads the print settings from the group @group_name in @key_file.
*
* @key_file: the `GKeyFile` to retrieve the settings from
* @group_name: (nullable): the name of the group to use, or %NULL to use
* the default “Print Settings”
- * @error: (nullable): return location for errors, or %NULL
+ * @error: (nullable): return location for errors
*
* Reads the print settings from the group @group_name in @key_file.
*
* gtk_print_settings_to_file:
* @settings: a `GtkPrintSettings`
* @file_name: (type filename): the file to save to
- * @error: (nullable): return location for errors, or %NULL
+ * @error: (nullable): return location for errors
*
* This function saves the print settings from @settings to @file_name.
*
/**
* gtk_print_unix_dialog_new:
- * @title: (nullable): Title of the dialog, or %NULL
- * @parent: (nullable): Transient parent of the dialog, or %NULL
+ * @title: (nullable): Title of the dialog
+ * @parent: (nullable): Transient parent of the dialog
*
* Creates a new `GtkPrintUnixDialog`.
*
/**
* gtk_print_unix_dialog_set_settings: (attributes org.gtk.Method.set_property=print-settings)
* @dialog: a `GtkPrintUnixDialog`
- * @settings: (nullable): a `GtkPrintSettings`, or %NULL
+ * @settings: (nullable): a `GtkPrintSettings`
*
* Sets the `GtkPrintSettings` for the `GtkPrintUnixDialog`.
*
/**
* gtk_progress_bar_set_text: (attributes org.gtk.Method.set_property=text)
* @pbar: a `GtkProgressBar`
- * @text: (nullable): a UTF-8 string, or %NULL
+ * @text: (nullable): a UTF-8 string
*
* Causes the given @text to appear next to the progress bar.
*
* The return value is a reference to the text, not a copy of it,
* so will become invalid if you change the text in the progress bar.
*
- * Returns: (nullable): text, or %NULL; this string is owned by the widget
- * and should not be modified or freed.
+ * Returns: (nullable): the text
*/
const char *
gtk_progress_bar_get_text (GtkProgressBar *pbar)
* gtk_recent_manager_remove_item:
* @manager: a `GtkRecentManager`
* @uri: the URI of the item you wish to remove
- * @error: (nullable): return location for a #GError, or %NULL
+ * @error: (nullable): return location for a #GError
*
* Removes a resource pointed by @uri from the recently used resources
* list handled by a recent manager.
* gtk_recent_manager_lookup_item:
* @manager: a `GtkRecentManager`
* @uri: a URI
- * @error: (nullable): a return location for a #GError, or %NULL
+ * @error: (nullable): a return location for a #GError
*
* Searches for a URI inside the recently used resources list, and
* returns a `GtkRecentInfo` containing information about the resource
* `gtk_widget_has_focus (widget)` will be %FALSE for the
* widget.
*
- * Returns: (nullable) (transfer none): the currently focused
- * widget, or %NULL if there is none.
+ * Returns: (nullable) (transfer none): the currently focused widget
*/
GtkWidget *
gtk_root_get_focus (GtkRoot *self)
/**
* gtk_scale_get_layout_offsets:
* @scale: a #GtkScale
- * @x: (out) (optional): location to store X offset of layout, or %NULL
- * @y: (out) (optional): location to store Y offset of layout, or %NULL
+ * @x: (out) (optional): location to store X offset of layout
+ * @y: (out) (optional): location to store Y offset of layout
*
* Obtains the coordinates where the scale will draw the
* `PangoLayout` representing the text in the scale.
* and %GTK_POS_LEFT are drawn above the scale, anything else below.
* For a vertical scale, #GTK_POS_LEFT and %GTK_POS_TOP are drawn to
* the left of the scale, anything else to the right.
- * @markup: (nullable): Text to be shown at the mark, using
- * Pango markup, or %NULL
+ * @markup: (nullable): Text to be shown at the mark, using Pango markup
*
* Adds a mark at @value.
*
/**
* gtk_selection_filter_model_new:
- * @model: (nullable) (transfer none): the selection model to filter, or %NULL
+ * @model: (nullable) (transfer none): the selection model to filter
*
* Creates a new `GtkSelectionFilterModel` that will include the
* selected items from the underlying selection model.
* `<` and `>` instead of `>`.
*
* Returns: (nullable) (transfer full): a new `GtkShortcutTrigger`
- * or %NULL on error
*/
GtkShortcutTrigger *
gtk_shortcut_trigger_parse_string (const char *string)
/**
* gtk_single_selection_new:
- * @model: (nullable) (transfer full): the `GListModel` to manage, or %NULL
+ * @model: (nullable) (transfer full): the `GListModel` to manage
*
* Creates a new selection to handle @model.
*
* the height the widget should be measured with. The %GTK_ORIENTATION_VERTICAL
* case is analogous. This way, both height-for-width and width-for-height
* requests can be implemented. If no size is known, -1 can be passed.
- * @minimum: (out) (optional): location to store the minimum size, or %NULL
- * @natural: (out) (optional): location to store the natural size, or %NULL
+ * @minimum: (out) (optional): location to store the minimum size
+ * @natural: (out) (optional): location to store the natural size
* @minimum_baseline: (out) (optional): location to store the baseline
- * position for the minimum size, or %NULL
+ * position for the minimum size
* @natural_baseline: (out) (optional): location to store the baseline
- * position for the natural size, or %NULL
+ * position for the natural size
*
* Measures @widget in the orientation @orientation and for the given @for_size.
*
/**
* gtk_widget_get_preferred_size:
* @widget: a `GtkWidget` instance
- * @minimum_size: (out) (optional): location for storing the minimum size, or %NULL
- * @natural_size: (out) (optional): location for storing the natural size, or %NULL
+ * @minimum_size: (out) (optional): location for storing the minimum size
+ * @natural_size: (out) (optional): location for storing the natural size
*
* Retrieves the minimum and natural size of a widget, taking
* into account the widget’s preference for height-for-width management.
/**
* gtk_slice_list_model_new:
- * @model: (transfer full) (nullable): The model to use, or %NULL
+ * @model: (transfer full) (nullable): The model to use
* @offset: the offset of the slice
* @size: maximum size of the slice
*
/**
* gtk_sort_list_model_new:
- * @model: (nullable) (transfer full): the model to sort, or %NULL
- * @sorter: (nullable) (transfer full): the `GtkSorter` to sort @model with, or %NULL
+ * @model: (nullable) (transfer full): the model to sort
+ * @sorter: (nullable) (transfer full): the `GtkSorter` to sort @model with,
*
* Creates a new sort list model that uses the @sorter to sort @model.
*
/**
* gtk_spin_button_new:
- * @adjustment: (nullable): the `GtkAdjustment` that this spin
- * button should use, or %NULL
+ * @adjustment: (nullable): the `GtkAdjustment` that this spin button should use
* @climb_rate: specifies by how much the rate of change in the value will
* accelerate if you continue to hold down an up/down button or arrow key
* @digits: the number of decimal places to display
/**
* gtk_spin_button_get_increments:
* @spin_button: a `GtkSpinButton`
- * @step: (out) (optional): location to store step increment, or %NULL
- * @page: (out) (optional): location to store page increment, or %NULL
+ * @step: (out) (optional): location to store step increment
+ * @page: (out) (optional): location to store page increment
*
* Gets the current step and page the increments
* used by @spin_button.
/**
* gtk_spin_button_get_range:
* @spin_button: a `GtkSpinButton`
- * @min: (out) (optional): location to store minimum allowed value, or %NULL
- * @max: (out) (optional): location to store maximum allowed value, or %NULL
+ * @min: (out) (optional): location to store minimum allowed value
+ * @max: (out) (optional): location to store maximum allowed value
*
* Gets the range allowed for @spin_button.
*
* gtk_stack_add_named:
* @stack: a `GtkStack`
* @child: the widget to add
- * @name: (nullable): the name for @child or %NULL
+ * @name: (nullable): the name for @child
*
* Adds a child to @stack.
*
*
* Retrieves the stack.
*
- * Returns: (nullable) (transfer none): the stack, or %NULL if
- * none has been set explicitly.
+ * Returns: (nullable) (transfer none): the stack
*/
GtkStack *
gtk_stack_switcher_get_stack (GtkStackSwitcher *switcher)
*
* Gets the expression that is evaluated to obtain strings from items.
*
- * Returns: (transfer none) (nullable): a `GtkExpression`, or %NULL
+ * Returns: (transfer none) (nullable): a `GtkExpression`
*/
GtkExpression *
gtk_string_sorter_get_expression (GtkStringSorter *self)
/**
* gtk_string_sorter_set_expression: (attributes org.gtk.Method.set_property=expression)
* @self: a `GtkStringSorter`
- * @expression: (nullable) (transfer none): a `GtkExpression`, or %NULL
+ * @expression: (nullable) (transfer none): a `GtkExpression`
*
* Sets the expression that is evaluated to obtain strings from items.
*
* Looks up the CSS property with the given @name. If no such
* property exists, %NULL is returned.
*
- * Returns: (nullable) (transfer none): The property or %NULL if no
- * property with the given name exists.
+ * Returns: (nullable) (transfer none): The property
*/
GtkStyleProperty *
_gtk_style_property_lookup (const char *name)
* gtk_text_set_placeholder_text: (attributes org.gtk.Method.set_property=placeholder-text)
* @self: a `GtkText`
* @text: (nullable): a string to be displayed when @self
- * is empty and unfocused, or %NULL
+ * is empty and unfocused
*
* Sets text to be displayed in @self when it is empty.
*
/**
* gtk_text_set_attributes: (attributes org.gtk.Method.set_property=attributes)
* @self: a `GtkText`
- * @attrs: (nullable): a `PangoAttrList` or %NULL to unset
+ * @attrs: (nullable): a `PangoAttrList`
*
* Sets attributes that are applied to the text.
*/
* Gets the attribute list that was set on the `GtkText`
* using gtk_text_set_attributes().
*
- * Returns: (transfer none) (nullable): the attribute list,
- * or %NULL if none was set.
+ * Returns: (transfer none) (nullable): the attribute list
*/
PangoAttrList *
gtk_text_get_attributes (GtkText *self)
* Gets the tabstops that were set on the `GtkText`
* using gtk_text_set_tabs().
*
- * Returns: (nullable) (transfer none): the tabstops,
- * or %NULL if none was set.
+ * Returns: (nullable) (transfer none): the tabstops
*/
PangoTabArray *
gtk_text_get_tabs (GtkText *self)
/**
* gtk_text_buffer_create_mark:
* @buffer: a `GtkTextBuffer`
- * @mark_name: (nullable): name for mark, or %NULL
+ * @mark_name: (nullable): name for mark
* @where: location to place mark
* @left_gravity: whether the mark has left gravity
*
* Returns the mark named @name in buffer @buffer, or %NULL if no such
* mark exists in the buffer.
*
- * Returns: (nullable) (transfer none): a #GtkTextMark, or %NULL
+ * Returns: (nullable) (transfer none): a #GtkTextMark
**/
GtkTextMark*
gtk_text_buffer_get_mark (GtkTextBuffer *buffer,
/**
* gtk_text_buffer_create_tag:
* @buffer: a `GtkTextBuffer`
- * @tag_name: (nullable): name of the new tag, or %NULL
- * @first_property_name: (nullable): name of first property to set, or %NULL
+ * @tag_name: (nullable): name of the new tag
+ * @first_property_name: (nullable): name of first property to set
* @...: %NULL-terminated list of property names and values
*
* Creates a tag and adds it to the tag table for @buffer.
* gtk_text_buffer_paste_clipboard:
* @buffer: a `GtkTextBuffer`
* @clipboard: the `GdkClipboard` to paste from
- * @override_location: (nullable): location to insert pasted text, or %NULL
+ * @override_location: (nullable): location to insert pasted text
* @default_editable: whether the buffer is editable by default
*
* Pastes the contents of a clipboard.
/**
* gtk_text_iter_starts_tag:
* @iter: an iterator
- * @tag: (nullable): a `GtkTextTag`, or %NULL
+ * @tag: (nullable): a `GtkTextTag`
*
* Returns %TRUE if @tag is toggled on at exactly this point.
*
/**
* gtk_text_iter_ends_tag:
* @iter: an iterator
- * @tag: (nullable): a `GtkTextTag`, or %NULL
+ * @tag: (nullable): a `GtkTextTag`
*
* Returns %TRUE if @tag is toggled off at exactly this point.
*
/**
* gtk_text_iter_toggles_tag:
* @iter: an iterator
- * @tag: (nullable): a `GtkTextTag`, or %NULL
+ * @tag: (nullable): a `GtkTextTag`
*
* Gets whether a range with @tag applied to it begins
* or ends at @iter.
/**
* gtk_text_iter_forward_to_tag_toggle:
* @iter: a `GtkTextIter`
- * @tag: (nullable): a `GtkTextTag`, or %NULL
+ * @tag: (nullable): a `GtkTextTag`
*
* Moves forward to the next toggle (on or off) of the
* @tag, or to the next toggle of any tag if
/**
* gtk_text_iter_backward_to_tag_toggle:
* @iter: a `GtkTextIter`
- * @tag: (nullable): a `GtkTextTag`, or %NULL
+ * @tag: (nullable): a `GtkTextTag`
*
* Moves backward to the next toggle (on or off) of the
* @tag, or to the next toggle of any tag if
* @iter: a `GtkTextIter`
* @pred: (scope call): a function to be called on each character
* @user_data: (closure): user data for @pred
- * @limit: (nullable): search limit, or %NULL for none
+ * @limit: (nullable): search limit
*
* Advances @iter, calling @pred on each character.
*
* @iter: a `GtkTextIter`
* @pred: (scope call): function to be called on each character
* @user_data: (closure): user data for @pred
- * @limit: (nullable): search limit, or %NULL for none
+ * @limit: (nullable): search limit
*
* Same as gtk_text_iter_forward_find_char(),
* but goes backward from @iter.
* @iter: start of search
* @str: a search string
* @flags: flags affecting how the search is done
- * @match_start: (out caller-allocates) (optional): return location for start of match, or %NULL
- * @match_end: (out caller-allocates) (optional): return location for end of match, or %NULL
+ * @match_start: (out caller-allocates) (optional): return location for start of match
+ * @match_end: (out caller-allocates) (optional): return location for end of match
* @limit: (nullable): location of last possible @match_end, or %NULL for the end of the buffer
*
* Searches forward for @str.
* @iter: a `GtkTextIter` where the search begins
* @str: search string
* @flags: bitmask of flags affecting the search
- * @match_start: (out caller-allocates) (optional): return location for start of match, or %NULL
- * @match_end: (out caller-allocates) (optional): return location for end of match, or %NULL
+ * @match_start: (out caller-allocates) (optional): return location for start of match
+ * @match_end: (out caller-allocates) (optional): return location for end of match
* @limit: (nullable): location of last possible @match_start, or %NULL for start of buffer
*
* Same as gtk_text_iter_forward_search(), but moves backward.
* gtk_text_layout_get_cursor_locations:
* @layout: a #GtkTextLayout
* @iter: a #GtkTextIter
- * @strong_pos: (out) (optional): location to store the strong cursor position, or %NULL
- * @weak_pos: (out) (optional): location to store the weak cursor position, or %NULL
+ * @strong_pos: (out) (optional): location to store the strong cursor position
+ * @weak_pos: (out) (optional): location to store the weak cursor position
*
* Given an iterator within a text layout, determine the positions of the
* strong and weak cursors if the insertion point is at that
/**
* gtk_text_mark_new:
- * @name: (nullable): mark name or %NULL
+ * @name: (nullable): mark name
* @left_gravity: whether the mark should have left gravity
*
* Creates a text mark.
/**
* gtk_text_tag_new:
- * @name: (nullable): tag name, or %NULL
+ * @name: (nullable): tag name
*
* Creates a `GtkTextTag`.
*
*
* Look up a named tag.
*
- * Returns: (nullable) (transfer none): The tag,
- * or %NULL if none by that name is in the table.
+ * Returns: (nullable) (transfer none): The tag
*/
GtkTextTag*
gtk_text_tag_table_lookup (GtkTextTagTable *table,
* @win must be one of %GTK_TEXT_WINDOW_LEFT, %GTK_TEXT_WINDOW_RIGHT,
* %GTK_TEXT_WINDOW_TOP, or %GTK_TEXT_WINDOW_BOTTOM.
*
- * Returns: (transfer none) (nullable): a `GtkWidget` or %NULL
+ * Returns: (transfer none) (nullable): a `GtkWidget`
*/
GtkWidget *
gtk_text_view_get_gutter (GtkTextView *text_view,
* gtk_text_view_set_gutter:
* @text_view: a `GtkTextView`
* @win: a `GtkTextWindowType`
- * @widget: (nullable): a `GtkWidget` or %NULL
+ * @widget: (nullable): a `GtkWidget`
*
* Places @widget into the gutter specified by @win.
*
* @win: a #GtkTextWindowType
* @buffer_x: buffer x coordinate
* @buffer_y: buffer y coordinate
- * @window_x: (out) (optional): window x coordinate return location or %NULL
- * @window_y: (out) (optional): window y coordinate return location or %NULL
+ * @window_x: (out) (optional): window x coordinate return location
+ * @window_y: (out) (optional): window y coordinate return location
*
* Converts buffer coordinates to window coordinates.
*/
* @win: a #GtkTextWindowType
* @window_x: window x coordinate
* @window_y: window y coordinate
- * @buffer_x: (out) (optional): buffer x coordinate return location or %NULL
- * @buffer_y: (out) (optional): buffer y coordinate return location or %NULL
+ * @buffer_x: (out) (optional): buffer x coordinate return location
+ * @buffer_y: (out) (optional): buffer y coordinate return location
*
* Converts coordinates on the window identified by @win to buffer
* coordinates.
/**
* gtk_tooltip_set_text:
* @tooltip: a `GtkTooltip`
- * @text: (nullable): a text string or %NULL
+ * @text: (nullable): a text string
*
* Sets the text of the tooltip to be @text.
*
/**
* gtk_tooltip_set_icon:
* @tooltip: a #GtkTooltip
- * @paintable: (nullable): a #GdkPaintable, or %NULL
+ * @paintable: (nullable): a #GdkPaintable
*
* Sets the icon of the tooltip (which is in front of the text) to be
* @paintable. If @paintable is %NULL, the image will be hidden.
/**
* gtk_tooltip_set_icon_from_icon_name:
* @tooltip: a #GtkTooltip
- * @icon_name: (nullable): an icon name, or %NULL
+ * @icon_name: (nullable): an icon name
*
* Sets the icon of the tooltip (which is in front of the text) to be
* the icon indicated by @icon_name with the size indicated
/**
* gtk_tooltip_set_icon_from_gicon:
* @tooltip: a #GtkTooltip
- * @gicon: (nullable): a #GIcon representing the icon, or %NULL
+ * @gicon: (nullable): a #GIcon representing the icon
*
* Sets the icon of the tooltip (which is in front of the text)
* to be the icon indicated by @gicon with the size indicated
* longer found in the model!
*
* Returns: (nullable) (transfer full): a #GdkContentProvider for the
- * given @path or %NULL if none exists
+ * given @path
**/
GdkContentProvider *
gtk_tree_drag_source_drag_data_get (GtkTreeDragSource *drag_source,
/**
* gtk_tree_expander_set_child: (attributes org.gtk.Method.set_property=child)
* @self: a `GtkTreeExpander`
- * @child: (nullable): a `GtkWidget`, or %NULL
+ * @child: (nullable): a `GtkWidget`
*
* Sets the content widget to display.
*/
/**
* gtk_tree_expander_set_list_row: (attributes org.gtk.Method.set_property=list-row)
* @self: a `GtkTreeExpander` widget
- * @list_row: (nullable): a `GtkTreeListRow`, or %NULL
+ * @list_row: (nullable): a `GtkTreeListRow`
*
* Sets the tree list row that this expander should manage.
*/
/**
* gtk_tree_list_row_sorter_new:
- * @sorter: (nullable) (transfer full): a `GtkSorter`, or %NULL
+ * @sorter: (nullable) (transfer full): a `GtkSorter`
*
* Create a special-purpose sorter that applies the sorting
* of @sorter to the levels of a `GtkTreeListModel`.
/**
* gtk_tree_list_row_sorter_set_sorter:
* @self: a `GtkTreeListRowSorter`
- * @sorter: (nullable) (transfer none): The sorter to use, or %NULL
+ * @sorter: (nullable) (transfer none): The sorter to use
*
* Sets the sorter to use for items with the same parent.
*
* child of that 11th child, and the 1st child of that 5th child.
* If an invalid path string is passed in, %NULL is returned.
*
- * Returns: (nullable): A newly-created #GtkTreePath-struct, or %NULL
+ * Returns: (nullable): A newly-created #GtkTreePath
*/
GtkTreePath *
gtk_tree_path_new_from_string (const char *path)
*
* The length of the array can be obtained with gtk_tree_path_get_depth().
*
- * Returns: (nullable): The current indices, or %NULL
+ * Returns: (nullable) (transfer none): The current indices
*/
int *
gtk_tree_path_get_indices (GtkTreePath *path)
* gtk_tree_path_get_indices_with_depth: (rename-to gtk_tree_path_get_indices)
* @path: a `GtkTreePath`
* @depth: (out) (optional): return location for number of elements
- * returned in the integer array, or %NULL
+ * returned in the integer array
*
* Returns the current indices of @path.
*
* It also returns the number of elements in the array.
* The array should not be freed.
*
- * Returns: (array length=depth) (transfer none): The current
- * indices, or %NULL
+ * Returns: (array length=depth) (transfer none) (nullable): The current
+ * indices
*/
int *
gtk_tree_path_get_indices_with_depth (GtkTreePath *path,
* gtk_tree_model_iter_children:
* @tree_model: a #GtkTreeModel
* @iter: (out): the new #GtkTreeIter-struct to be set to the child
- * @parent: (nullable): the #GtkTreeIter-struct, or %NULL
+ * @parent: (nullable): the #GtkTreeIter
*
* Sets @iter to point to the first child of @parent.
*
/**
* gtk_tree_model_iter_n_children:
* @tree_model: a #GtkTreeModel
- * @iter: (nullable): the #GtkTreeIter-struct, or %NULL
+ * @iter: (nullable): the #GtkTreeIter
*
* Returns the number of children that @iter has.
*
/**
* gtk_tree_model_iter_nth_child:
* @tree_model: a #GtkTreeModel
- * @iter: (out): the #GtkTreeIter-struct to set to the nth child
- * @parent: (nullable): the #GtkTreeIter-struct to get the child from, or %NULL.
+ * @iter: (out): the #GtkTreeIter to set to the nth child
+ * @parent: (nullable): the #GtkTreeIter to get the child from
* @n: the index of the desired child
*
* Sets @iter to be the child of @parent, using the given index.
* propagated, and the path is updated appropriately. If
* @path isn’t a valid path in @model, then %NULL is returned.
*
- * Returns: (nullable): a newly allocated #GtkTreeRowReference, or %NULL
+ * Returns: (nullable): a newly allocated #GtkTreeRowReference
*/
GtkTreeRowReference *
gtk_tree_row_reference_new (GtkTreeModel *model,
* need to carefully monitor exactly when a row reference updates
* itself, and is not generally needed by most applications.
*
- * Returns: (nullable): a newly allocated #GtkTreeRowReference, or %NULL
+ * Returns: (nullable): a newly allocated #GtkTreeRowReference
*/
GtkTreeRowReference *
gtk_tree_row_reference_new_proxy (GObject *proxy,
* Returns a path that the row reference currently points to,
* or %NULL if the path pointed to is no longer valid.
*
- * Returns: (nullable) (transfer full): a current path, or %NULL
+ * Returns: (nullable) (transfer full): a current path
*/
GtkTreePath *
gtk_tree_row_reference_get_path (GtkTreeRowReference *reference)
/**
* gtk_tree_row_reference_valid:
- * @reference: (nullable): a #GtkTreeRowReference, or %NULL
+ * @reference: (nullable): a #GtkTreeRowReference
*
* Returns %TRUE if the @reference is non-%NULL and refers to
* a current valid path.
/**
* gtk_tree_row_reference_free:
- * @reference: (nullable): a #GtkTreeRowReference, or %NULL
+ * @reference: (nullable): a #GtkTreeRowReference
*
* Free’s @reference. @reference may be %NULL
*/
/**
* gtk_tree_model_filter_new:
* @child_model: A #GtkTreeModel.
- * @root: (nullable): A #GtkTreePath or %NULL.
+ * @root: (nullable): A #GtkTreePath
*
* Creates a new #GtkTreeModel, with @child_model as the child_model
* and @root as the virtual root.
* gtk_tree_model_filter_set_visible_func:
* @filter: A #GtkTreeModelFilter
* @func: A #GtkTreeModelFilterVisibleFunc, the visible function
- * @data: (nullable): User data to pass to the visible function, or %NULL
- * @destroy: (nullable): Destroy notifier of @data, or %NULL
+ * @data: (nullable): User data to pass to the visible function
+ * @destroy: (nullable): Destroy notifier of @data
*
* Sets the visible function used when filtering the @filter to be @func.
* The function should return %TRUE if the given row should be visible and
* @n_columns: The number of columns in the filter model.
* @types: (array length=n_columns): The #GTypes of the columns.
* @func: A #GtkTreeModelFilterModifyFunc
- * @data: (nullable): User data to pass to the modify function, or %NULL.
- * @destroy: (nullable): Destroy notifier of @data, or %NULL.
+ * @data: (nullable): User data to pass to the modify function
+ * @destroy: (nullable): Destroy notifier of @data
*
* With the @n_columns and @types parameters, you give an array of column
* types for this model (which will be exposed to the parent model/view).
* child model or points to a row which is not visible in @filter, then %NULL
* is returned.
*
- * Returns: (nullable) (transfer full): A newly allocated #GtkTreePath, or %NULL.
+ * Returns: (nullable) (transfer full): A newly allocated #GtkTreePath
*/
GtkTreePath *
gtk_tree_model_filter_convert_child_path_to_path (GtkTreeModelFilter *filter,
* point to the same location in the model not being filtered. If @filter_path
* does not point to a location in the child model, %NULL is returned.
*
- * Returns: (nullable) (transfer full): A newly allocated #GtkTreePath, or %NULL.
+ * Returns: (nullable) (transfer full): A newly allocated #GtkTreePath
*/
GtkTreePath *
gtk_tree_model_filter_convert_path_to_child_path (GtkTreeModelFilter *filter,
/**
* gtk_tree_model_sort_set_model:
* @tree_model_sort: The #GtkTreeModelSort.
- * @child_model: (nullable): A #GtkTreeModel, or %NULL.
+ * @child_model: (nullable): A #GtkTreeModel
*
* Sets the model of @tree_model_sort to be @model. If @model is %NULL,
* then the old model is unset. The sort function is unset as a result
* point to the same row in the sorted model. If @child_path isn’t a valid
* path on the child model, then %NULL is returned.
*
- * Returns: (nullable) (transfer full): A newly allocated #GtkTreePath, or %NULL
+ * Returns: (nullable) (transfer full): A newly allocated #GtkTreePath
**/
GtkTreePath *
gtk_tree_model_sort_convert_child_path_to_path (GtkTreeModelSort *tree_model_sort,
* sorted. If @sorted_path does not point to a location in the child model,
* %NULL is returned.
*
- * Returns: (nullable) (transfer full): A newly allocated #GtkTreePath, or %NULL
+ * Returns: (nullable) (transfer full): A newly allocated #GtkTreePath
**/
GtkTreePath *
gtk_tree_model_sort_convert_path_to_child_path (GtkTreeModelSort *tree_model_sort,
/**
* gtk_tree_selection_get_selected_rows:
* @selection: A #GtkTreeSelection.
- * @model: (out) (optional) (transfer none): A pointer to set to the #GtkTreeModel, or %NULL.
+ * @model: (out) (optional) (transfer none): A pointer to set to the #GtkTreeModel
*
* Creates a list of path of all selected rows. Additionally, if you are
* planning on modifying the model after calling this function, you may
* @sortable: A #GtkTreeSortable
* @sort_column_id: the sort column id to set the function for
* @sort_func: The comparison function
- * @user_data: (closure): User data to pass to @sort_func, or %NULL
- * @destroy: (nullable): Destroy notifier of @user_data, or %NULL
+ * @user_data: (closure): User data to pass to @sort_func
+ * @destroy: (nullable): Destroy notifier of @user_data
*
* Sets the comparison function used when sorting to be @sort_func. If the
* current sort column id of @sortable is the same as @sort_column_id, then
* gtk_tree_sortable_set_default_sort_func:
* @sortable: A #GtkTreeSortable
* @sort_func: The comparison function
- * @user_data: (closure): User data to pass to @sort_func, or %NULL
- * @destroy: (nullable): Destroy notifier of @user_data, or %NULL
+ * @user_data: (closure): User data to pass to @sort_func
+ * @destroy: (nullable): Destroy notifier of @user_data
*
* Sets the default comparison function used when sorting to be @sort_func.
* If the current sort column id of @sortable is
* gtk_tree_store_insert:
* @tree_store: A #GtkTreeStore
* @iter: (out): An unset #GtkTreeIter to set to the new row
- * @parent: (nullable): A valid #GtkTreeIter, or %NULL
+ * @parent: (nullable): A valid #GtkTreeIter
* @position: position to insert the new row, or -1 for last
*
* Creates a new row at @position. If parent is non-%NULL, then the row will be
* gtk_tree_store_insert_before:
* @tree_store: A #GtkTreeStore
* @iter: (out): An unset #GtkTreeIter to set to the new row
- * @parent: (nullable): A valid #GtkTreeIter, or %NULL
- * @sibling: (nullable): A valid #GtkTreeIter, or %NULL
+ * @parent: (nullable): A valid #GtkTreeIter
+ * @sibling: (nullable): A valid #GtkTreeIter
*
* Inserts a new row before @sibling. If @sibling is %NULL, then the row will
* be appended to @parent ’s children. If @parent and @sibling are %NULL, then
* gtk_tree_store_insert_after:
* @tree_store: A #GtkTreeStore
* @iter: (out): An unset #GtkTreeIter to set to the new row
- * @parent: (nullable): A valid #GtkTreeIter, or %NULL
- * @sibling: (nullable): A valid #GtkTreeIter, or %NULL
+ * @parent: (nullable): A valid #GtkTreeIter
+ * @sibling: (nullable): A valid #GtkTreeIter
*
* Inserts a new row after @sibling. If @sibling is %NULL, then the row will be
* prepended to @parent ’s children. If @parent and @sibling are %NULL, then
/**
* gtk_tree_store_insert_with_values:
* @tree_store: A #GtkTreeStore
- * @iter: (out) (optional): An unset #GtkTreeIter to set the new row, or %NULL.
- * @parent: (nullable): A valid #GtkTreeIter, or %NULL
+ * @iter: (out) (optional): An unset #GtkTreeIter to set the new row
+ * @parent: (nullable): A valid #GtkTreeIter
* @position: position to insert the new row, or -1 to append after existing rows
* @...: pairs of column number and value, terminated with -1
*
/**
* gtk_tree_store_insert_with_valuesv: (rename-to gtk_tree_store_insert_with_values)
* @tree_store: A #GtkTreeStore
- * @iter: (out) (optional): An unset #GtkTreeIter to set the new row, or %NULL.
- * @parent: (nullable): A valid #GtkTreeIter, or %NULL
+ * @iter: (out) (optional): An unset #GtkTreeIter to set the new row
+ * @parent: (nullable): A valid #GtkTreeIter
* @position: position to insert the new row, or -1 for last
* @columns: (array length=n_values): an array of column numbers
* @values: (array length=n_values): an array of GValues
* gtk_tree_store_prepend:
* @tree_store: A #GtkTreeStore
* @iter: (out): An unset #GtkTreeIter to set to the prepended row
- * @parent: (nullable): A valid #GtkTreeIter, or %NULL
+ * @parent: (nullable): A valid #GtkTreeIter
*
* Prepends a new row to @tree_store. If @parent is non-%NULL, then it will prepend
* the new row before the first child of @parent, otherwise it will prepend a row
* gtk_tree_store_append:
* @tree_store: A #GtkTreeStore
* @iter: (out): An unset #GtkTreeIter to set to the appended row
- * @parent: (nullable): A valid #GtkTreeIter, or %NULL
+ * @parent: (nullable): A valid #GtkTreeIter
*
* Appends a new row to @tree_store. If @parent is non-%NULL, then it will append the
* new row after the last child of @parent, otherwise it will append a row to
/**
* gtk_tree_store_reorder: (skip)
* @tree_store: A `GtkTreeStore`
- * @parent: (nullable): A `GtkTreeIter`, or %NULL
+ * @parent: (nullable): A `GtkTreeIter`
* @new_order: (array): an array of integers mapping the new position of each child
* to its old position before the re-ordering,
* i.e. @new_order`[newpos] = oldpos`.
* gtk_tree_store_move_before:
* @tree_store: A #GtkTreeStore.
* @iter: A #GtkTreeIter.
- * @position: (nullable): A #GtkTreeIter or %NULL.
+ * @position: (nullable): A #GtkTreeIter
*
* Moves @iter in @tree_store to the position before @position. @iter and
* @position should be in the same level. Note that this function only
* Returns the model the #GtkTreeView is based on. Returns %NULL if the
* model is unset.
*
- * Returns: (transfer none) (nullable): A #GtkTreeModel, or %NULL if
- * none is currently being used.
+ * Returns: (transfer none) (nullable): A #GtkTreeModel
**/
GtkTreeModel *
gtk_tree_view_get_model (GtkTreeView *tree_view)
* gtk_tree_view_move_column_after:
* @tree_view: A #GtkTreeView
* @column: The #GtkTreeViewColumn to be moved.
- * @base_column: (nullable): The #GtkTreeViewColumn to be moved relative to, or %NULL.
+ * @base_column: (nullable): The #GtkTreeViewColumn to be moved relative to
*
* Moves @column to be after to @base_column. If @base_column is %NULL, then
* @column is placed in the first position.
/**
* gtk_tree_view_set_column_drag_function:
* @tree_view: A #GtkTreeView.
- * @func: (nullable): A function to determine which columns are reorderable, or %NULL.
- * @user_data: (closure): User data to be passed to @func, or %NULL
- * @destroy: (nullable): Destroy notifier for @user_data, or %NULL
+ * @func: (nullable): A function to determine which columns are reorderable
+ * @user_data: (closure): User data to be passed to @func
+ * @destroy: (nullable): Destroy notifier for @user_data
*
* Sets a user function for determining where a column may be dropped when
* dragged. This function is called on every column pair in turn at the
/**
* gtk_tree_view_scroll_to_cell:
* @tree_view: A #GtkTreeView.
- * @path: (nullable): The path of the row to move to, or %NULL.
- * @column: (nullable): The #GtkTreeViewColumn to move horizontally to, or %NULL.
+ * @path: (nullable): The path of the row to move to
+ * @column: (nullable): The #GtkTreeViewColumn to move horizontally to
* @use_align: whether to use alignment arguments, or %FALSE.
* @row_align: The vertical alignment of the row specified by @path.
* @col_align: The horizontal alignment of the column specified by @column.
* gtk_tree_view_get_cursor:
* @tree_view: A #GtkTreeView
* @path: (out) (transfer full) (optional) (nullable): A pointer to be
- * filled with the current cursor path, or %NULL
+ * filled with the current cursor path
* @focus_column: (out) (transfer none) (optional) (nullable): A
- * pointer to be filled with the current focus column, or %NULL
+ * pointer to be filled with the current focus column
*
* Fills in @path and @focus_column with the current path and focus column. If
* the cursor isn’t currently set, then *@path will be %NULL. If no column
* gtk_tree_view_set_cursor:
* @tree_view: A #GtkTreeView
* @path: A #GtkTreePath
- * @focus_column: (nullable): A #GtkTreeViewColumn, or %NULL
+ * @focus_column: (nullable): A #GtkTreeViewColumn
* @start_editing: %TRUE if the specified cell should start being edited.
*
* Sets the current keyboard focus to be at @path, and selects it. This is
* gtk_tree_view_set_cursor_on_cell:
* @tree_view: A #GtkTreeView
* @path: A #GtkTreePath
- * @focus_column: (nullable): A #GtkTreeViewColumn, or %NULL
- * @focus_cell: (nullable): A #GtkCellRenderer, or %NULL
+ * @focus_column: (nullable): A #GtkTreeViewColumn
+ * @focus_cell: (nullable): A #GtkCellRenderer
* @start_editing: %TRUE if the specified cell should start being edited.
*
* Sets the current keyboard focus to be at @path, and selects it. This is
* @x: The x position to be identified (relative to bin_window).
* @y: The y position to be identified (relative to bin_window).
* @path: (out) (optional) (nullable): A pointer to a #GtkTreePath
- * pointer to be filled in, or %NULL
+ * pointer to be filled in
* @column: (out) (transfer none) (optional) (nullable): A pointer to
- * a #GtkTreeViewColumn pointer to be filled in, or %NULL
+ * a #GtkTreeViewColumn pointer to be filled in
* @cell_x: (out) (optional): A pointer where the X coordinate
- * relative to the cell can be placed, or %NULL
+ * relative to the cell can be placed
* @cell_y: (out) (optional): A pointer where the Y coordinate
- * relative to the cell can be placed, or %NULL
+ * relative to the cell can be placed
*
* Finds the path at the point (@x, @y), relative to bin_window coordinates.
* That is, @x and @y are relative to an events coordinates. Widget-relative
* @x: The x position to be identified (relative to bin_window)
* @y: The y position to be identified (relative to bin_window)
* @path: (out) (optional) (nullable): A pointer to a #GtkTreePath pointer to
- * be filled in, or %NULL
+ * be filled in
* @column: (out) (transfer none) (optional) (nullable): A pointer to a
- * #GtkTreeViewColumn pointer to be filled in, or %NULL
+ * #GtkTreeViewColumn pointer to be filled in
* @cell_x: (out) (optional): A pointer where the X coordinate relative to the
- * cell can be placed, or %NULL
+ * cell can be placed
* @cell_y: (out) (optional): A pointer where the Y coordinate relative to the
- * cell can be placed, or %NULL
+ * cell can be placed
*
* Determine whether the point (@x, @y) in @tree_view is blank, that is no
* cell content nor an expander arrow is drawn at the location. If so, the
/**
* gtk_tree_view_set_drag_dest_row:
* @tree_view: a #GtkTreeView
- * @path: (nullable): The path of the row to highlight, or %NULL
+ * @path: (nullable): The path of the row to highlight
* @pos: Specifies whether to drop before, after or into the row
*
* Sets the row that is highlighted for feedback.
/**
* gtk_tree_view_get_drag_dest_row:
* @tree_view: a #GtkTreeView
- * @path: (out) (optional) (nullable): Return location for the path of the highlighted row, or %NULL.
- * @pos: (out) (optional): Return location for the drop position, or %NULL
+ * @path: (out) (optional) (nullable): Return location for the path of the highlighted row
+ * @pos: (out) (optional): Return location for the drop position
*
* Gets information about the row that is highlighted for feedback.
**/
* @drag_x: the position to determine the destination row for
* @drag_y: the position to determine the destination row for
* @path: (out) (optional) (nullable): Return location for the path of
- * the highlighted row, or %NULL.
+ * the highlighted row
* @pos: (out) (optional): Return location for the drop position, or
* %NULL
*
* gtk_tree_view_set_search_equal_func:
* @tree_view: A #GtkTreeView
* @search_equal_func: the compare function to use during the search
- * @search_user_data: (nullable): user data to pass to @search_equal_func, or %NULL
- * @search_destroy: (nullable): Destroy notifier for @search_user_data, or %NULL
+ * @search_user_data: (nullable): user data to pass to @search_equal_func
+ * @search_destroy: (nullable): Destroy notifier for @search_user_data
*
* Sets the compare function for the interactive search capabilities; note
* that somewhat like strcmp() returning 0 for equality
/**
* gtk_tree_view_set_search_entry:
* @tree_view: A #GtkTreeView
- * @entry: (nullable): the entry the interactive search code of @tree_view should use or %NULL
+ * @entry: (nullable): the entry the interactive search code of @tree_view should use
*
* Sets the entry which the interactive search code will use for this
* @tree_view. This is useful when you want to provide a search entry
* gtk_tree_view_set_row_separator_func:
* @tree_view: a #GtkTreeView
* @func: (nullable): a #GtkTreeViewRowSeparatorFunc
- * @data: (nullable): user data to pass to @func, or %NULL
- * @destroy: (nullable): destroy notifier for @data, or %NULL
+ * @data: (nullable): user data to pass to @func
+ * @destroy: (nullable): destroy notifier for @data
*
* Sets the row separator function, which is used to determine
* whether a row should be drawn as a separator. If the row separator
* gtk_tree_view_set_tooltip_cell:
* @tree_view: a #GtkTreeView
* @tooltip: a #GtkTooltip
- * @path: (nullable): a #GtkTreePath or %NULL
- * @column: (nullable): a #GtkTreeViewColumn or %NULL
- * @cell: (nullable): a #GtkCellRenderer or %NULL
+ * @path: (nullable): a #GtkTreePath
+ * @column: (nullable): a #GtkTreeViewColumn
+ * @cell: (nullable): a #GtkCellRenderer
*
* Sets the tip area of @tooltip to the area @path, @column and @cell have
* in common. For example if @path is %NULL and @column is set, the tip
/**
* gtk_tree_view_column_set_widget:
* @tree_column: A #GtkTreeViewColumn.
- * @widget: (nullable): A child #GtkWidget, or %NULL.
+ * @widget: (nullable): A child #GtkWidget
*
* Sets the widget in the header to be @widget. If widget is %NULL, then the
* header button is set with a #GtkLabel set to the title of @tree_column.
/**
* gtk_tree_view_column_cell_get_size:
* @tree_column: A #GtkTreeViewColumn.
- * @x_offset: (out) (optional): location to return x offset of a cell relative to @cell_area, or %NULL
- * @y_offset: (out) (optional): location to return y offset of a cell relative to @cell_area, or %NULL
- * @width: (out) (optional): location to return width needed to render a cell, or %NULL
- * @height: (out) (optional): location to return height needed to render a cell, or %NULL
+ * @x_offset: (out) (optional): location to return x offset of a cell relative to @cell_area
+ * @y_offset: (out) (optional): location to return y offset of a cell relative to @cell_area
+ * @width: (out) (optional): location to return width needed to render a cell
+ * @height: (out) (optional): location to return height needed to render a cell
*
* Obtains the width and height needed to render the column. This is used
* primarily by the #GtkTreeView.
*
* Unrealized widgets do not have a frame clock.
*
- * Returns: (nullable) (transfer none): a `GdkFrameClock`,
- * or %NULL if widget is unrealized
+ * Returns: (nullable) (transfer none): a `GdkFrameClock`
*/
GdkFrameClock*
gtk_widget_get_frame_clock (GtkWidget *widget)
/**
* gtk_widget_set_font_options:
* @widget: a `GtkWidget`
- * @options: (nullable): a #cairo_font_options_t, or %NULL
+ * @options: (nullable): a #cairo_font_options_t
* to unset any previously set default font options
*
* Sets the `cairo_font_options_t` used for Pango rendering
*
* See [method@Gtk.Widget.set_font_map].
*
- * Returns: (transfer none) (nullable): A `PangoFontMap`, or %NULL
+ * Returns: (transfer none) (nullable): A `PangoFontMap`
*/
PangoFontMap *
gtk_widget_get_font_map (GtkWidget *widget)
* gtk_widget_activate_action_variant: (rename-to gtk_widget_activate_action)
* @widget: a `GtkWidget`
* @name: the name of the action to activate
- * @args: (nullable): parameters to use, or %NULL
+ * @args: (nullable): parameters to use
*
* Looks up the action in the action groups associated with
* @widget and its ancestors, and activates it.
* gtk_widget_class_install_action:
* @widget_class: a `GtkWidgetClass`
* @action_name: a prefixed action name, such as "clipboard.paste"
- * @parameter_type: (nullable): the parameter type, or %NULL
+ * @parameter_type: (nullable): the parameter type
* @activate: (scope call): callback to use when the action is activated
*
* This should be called at class initialization time to specify
/**
* gtk_widget_paintable_new:
- * @widget: (nullable) (transfer none): a `GtkWidget` or %NULL
+ * @widget: (nullable) (transfer none): a `GtkWidget`
*
* Creates a new widget paintable observing the given widget.
*
/**
* gtk_widget_paintable_set_widget: (attributes org.gtk.Method.set_property=widget)
* @self: a `GtkWidgetPaintable`
- * @widget: (nullable): the widget to observe or %NULL
+ * @widget: (nullable): the widget to observe
*
* Sets the widget that should be observed.
*/
*
* Retrieves the title of the window.
*
- * Returns: (nullable): the title of the window, or %NULL if none has
- * been set explicitly. The returned string is owned by the widget
- * and must not be modified or freed.
+ * Returns: (nullable): the title of the window
*/
const char *
gtk_window_get_title (GtkWindow *window)
/**
* gtk_window_set_default_widget: (attributes org.gtk.Property.set=default-widget)
* @window: a `GtkWindow`
- * @default_widget: (nullable): widget to be the default, or %NULL
+ * @default_widget: (nullable): widget to be the default
* to unset the default widget for the toplevel
*
* Sets the default widget.
*
* Returns the default widget for @window.
*
- * Returns: (nullable) (transfer none): the default widget, or %NULL
- * if there is none.
+ * Returns: (nullable) (transfer none): the default widget
*/
GtkWidget *
gtk_window_get_default_widget (GtkWindow *window)
* is not focused then `gtk_widget_has_focus (widget)` will
* not be %TRUE for the widget.
*
- * Returns: (nullable) (transfer none): the currently focused widget,
- * or %NULL if there is none.
+ * Returns: (nullable) (transfer none): the currently focused widget
*/
GtkWidget *
gtk_window_get_focus (GtkWindow *window)
/**
* gtk_window_set_transient_for: (attributes org.gtk.Method.set_property=transient-for)
* @window: a `GtkWindow`
- * @parent: (nullable): parent window, or %NULL
+ * @parent: (nullable): parent window
*
* Dialog windows should be set transient for the main application
* window they were spawned from. This allows window managers to e.g.
*
* Fetches the transient parent for this window.
*
- * Returns: (nullable) (transfer none): the transient parent for this
- * window, or %NULL if no transient parent has been set.
+ * Returns: (nullable) (transfer none): the transient parent for this window
*/
GtkWindow *
gtk_window_get_transient_for (GtkWindow *window)
*
* Gets the `GtkApplication` associated with the window.
*
- * Returns: (nullable) (transfer none): a `GtkApplication`, or %NULL
+ * Returns: (nullable) (transfer none): a `GtkApplication`
*/
GtkApplication *
gtk_window_get_application (GtkWindow *window)
* Returns the custom titlebar that has been set with
* gtk_window_set_titlebar().
*
- * Returns: (nullable) (transfer none): the custom titlebar, or %NULL
+ * Returns: (nullable) (transfer none): the custom titlebar
*/
GtkWidget *
gtk_window_get_titlebar (GtkWindow *window)
*
* Returns the name of the themed icon for the window.
*
- * Returns: (nullable): the icon name or %NULL if the window has
- * no themed icon
+ * Returns: (nullable): the icon name
*/
const char *
gtk_window_get_icon_name (GtkWindow *window)
/**
* gtk_window_get_default_size:
* @window: a `GtkWindow`
- * @width: (out) (optional): location to store the default width, or %NULL
- * @height: (out) (optional): location to store the default height, or %NULL
+ * @width: (out) (optional): location to store the default width
+ * @height: (out) (optional): location to store the default height
*
* Gets the default size of the window.
*
/**
* gtk_window_get_group:
- * @window: (nullable): a `GtkWindow`, or %NULL
+ * @window: (nullable): a `GtkWindow`
*
* Returns the group for @window.
*
projects / gtk4.git / commitdiff